Skip to content

Commit

Permalink
[Gitブランチフロー規約]コミットフックについて追記 (#210)
Browse files Browse the repository at this point in the history
* git commit hoook

* npm run format
  • Loading branch information
ma91n authored Dec 26, 2024
1 parent 8b346ac commit 692389e
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions documents/forGitBranch/git_branch_standards.md
Original file line number Diff line number Diff line change
Expand Up @@ -667,6 +667,17 @@ git config --global alias.br branch

- チームメンバー全員にgit-secretsを導入する

## コミットフックでテスト実行は行わない

[git hooks](https://git-scm.com/book/ja/v2/Git-%E3%81%AE%E3%82%AB%E3%82%B9%E3%82%BF%E3%83%9E%E3%82%A4%E3%82%BA-Git-%E3%83%95%E3%83%83%E3%82%AF) を用いて、コミットやプッシュ時に単体テスト実行などのカスタム処理を追加することができる。これを用いると、ローカルでの動作検証などを未実施な状態でレビュー依頼をしてしまうといった状況を未然に防ぎ、開発フローを強制的に適用することができる。

本規約の推奨と理由は以下。

- git hooksを用いたテスト実行は行わない
- gitのコマンドを実行するライフサイクルと、動作検証を行いたいライフサイクルは同じでないため、軽微な修正の度ににテストが実行されると、作業効率が下がるため
- CI側でテストが実行されるため、最悪CIで検知が可能
- 開発者にとって作業効率を考えると、CIで検知ではなくローカルでテスト実行を通してからプッシュするため、CIが整備されている前提ではgit hooksで強制する必然性がないため

## GitHub推奨設定

業務利用でのチーム開発を想定しており、リポジトリは以下の条件を満たす前提とする。
Expand Down

0 comments on commit 692389e

Please sign in to comment.