0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

Git 運用 コミットメッセージ

Posted at

image.png

はじめに

各プロジェクトの背景により、自社の GitHub が利用できい事もあるので、GitHubの運用を少しずつまとめて行きたいと思いました。
共通的な GitHub の Wiki に書こうかと思ったのですが、折角なので Qiita で記載したいと思います。
以前記載した「GitHub ざっくり How to use.」からの続きとして、今後も継続して記載します!

前提

単位

コミットは意味のある最小の単位で行う
コミット(プッシュ)後に「アレ忘れた」や「コメントアウトの削除忘れた」などの場合は、めんどくさがらずに rebase などで適切なサイズのコミットに修正を行う
レビュアーにやさしいコミット(PR)を心がけましょう!

フロー

  1. GitHub Issue の作成
  2. Branch の作成
  3. プログラム修正
  4. Git Commit

基本的な構造

<type>: <#issue-number> <subject>

[optional body]

コミットメッセージの例:

  • feat: #10 add excellent feature
  • docs: #10 update API document

type

  • feat: 機能の追加や修正。パフォーマンスの改善は機能の追加として扱う
  • fix: バグ修正
  • docs: ドキュメントの追加や修正
    • コード内のコメントの追加や修正は、ドキュメントの変更として扱う
  • chore: ビルドプロセスやツールの変更、フォルダ構造の変更など
  • test: テストの追加や修正
  • refactor: バグ修正や機能追加を含まないコードの変更
    • 不要なコードの削除
    • コードの可読性や保守性を向上させるための変数名の変更
    • コーディングのスタイルに関する変更(コード意味に影響しない変更、空白、フォーマットなど)

subject について

  • 修正内容を英語で要約する
  • 一行にする

optional body

  • コミットの詳細を記載
  • 箇条書きで記載
  • 複数記載可能
  • 英語、日本語のどちらかで記載

おわりに

少しずつまとめます。


参考(感謝)

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?