base_template_ja

コントリビューティングガイドライン

動作要件

ツール バージョン
Node.js .tool-versions
npm package.json における engines.npm の値
gibo ^3.0.11
yamllint ^1.35.1
actionlint .tool-versions

規約

カテゴリー 規約
Git コミット Conventional Commits v1.0.0
  @commitlint/config-conventional
Git ブランチ戦略 GitHub flow
バージョニング セマンティック バージョニング 2.0.0
GitHub PR タイトル コミットメッセージ規約と同じ

開発フロー

  1. 当リポジトリをフォーク
  2. フォークしたリポジトリ上で上述の規約に従って開発し、Pull Request (PR) を作成
  3. 当リポジトリのメンテナーが PR をレビュー
  4. メンテナーが PR を承認した場合、メンテナーが PR ブランチをマージします。否認した場合はマージせずにクローズします

インストール

git clone git@github.com:<your org>/base_template_ja.git
cd base_template_ja
make dev-install

Lint

make lint

Git コミット

npm run commit # commitlint アダプターを伴った Commitizen を利用
# or
npm run cm     # `npm run commit` のエイリアス
# or
git commit     # 通常の Git コミット