ハンドブックへのコントリビュート方法

フロー

  • https://github.com/livesense-inc/engineering-handbook にPull Requestを出してください
  • デフォルトでengineer-prチームがレビュアーにアサインされます。必要に応じてレビューしてほしい方を追加してください
  • mainブランチにマージすることでGitBookに自動で同期されます(反映に1〜2分程度かかります)

ページの追加・削除

  • SUMMARY.md に階層の追加をお願いします
  • ファイル名がURLになります

画像の追加

  • .gitbook/assets配下に追加し、以下のように読み込んでください
![alt](/.gitbook/assets/filename)

Lint

  • GitHub ActionsでPushするたびにtextlintが実行されます

ローカルでの実行方法

# インストール
npm install
# textlintの実行
npm run textlint -- -f pretty-error .
# autofix
npm run textlint -- --fix .
# ファイルを指定
npm run textlint -- -f pretty-error blog/XXX.md
npm run textlint -- --fix blog/XXX.md

ブログ執筆

こちらのリポジトリのtextlintの設定をブログ執筆等に活用したい場合は、blogディレクトリ以下にファイルや既存のドキュメントを書き溜めているディレクトリへのシンボリックリンクを置いてください。

表記揺れ対応

Contributors (任意の形式で追記してください)