gitコミットメッセージを作成するルール

3332 ワード
naming convention commit テキストリンク
今まで、私は自分のルールに従って提出情報を書いただけです.
これまで規模の大きいチームプロジェクトは行われていなかったので問題はありませんでしたが、今は提出情報を正確に記入する方法を参考にして、記入に注意する練習をよくしたほうがいいです.

⚔▼メッセージを提出する7つのルール

  • タイトルと本文空白行
  • タイトル制限50文字以内
    • タイトルの頭文字は
  • で、大文字は
    • です.
  • タイトル末尾に句点を付けない
  • タイトルは命令文です!古いものなし
  • 本明細書の各行72文字以内の
  • はどのように何をどのように解釈するかとなぜ

    • ⚔▼メッセージ構造のコミット


    ヘッダーは必須で、範囲(scope)、本文(body)、脚注(footer)はオプションです.
    <type>(<scope>): <subject>          -- 헤더
//<BLANK LINE>
<body>                              -- 본문
//<BLANK LINE>
<footer>                            -- 바닥글
    分かりやすい例としては、以下のようになります.
    Feat: 관심지역 알림 ON/OFF 기능 추가(#123)
시군구의 알림을 각각 ON/OFF 할 수 있도록 기능을 추가함 
- opnion0055: 구분 코드 해결: #123

//출처: https://xtring-dev.tistory.com/entry/Git-규칙적인-Commit-메세지로-개발팀-협업하기-👾 [xtring.dev]

    🗡 header


    type

    <type>はこの提出の性質を表し、以下のいずれかであるべきである.
    feat : 새로운 기능에 대한 커밋
fix : 버그 수정에 대한 커밋
build : 빌드 관련 파일 수정에 대한 커밋
chore : 그 외 자잘한 수정에 대한 커밋
ci : CI관련 설정 수정에 대한 커밋
docs : 문서 수정에 대한 커밋
style : 코드 스타일 혹은 포맷 등에 관한 커밋
refactor :  코드 리팩토링에 대한 커밋
test : 테스트 코드 수정에 대한 커밋

    scope


    subject


    🗡 body

    <body>は本文で、タイトルでは表現できない詳細を書きます.
    タイトルで表現できるなら省略できます.
    行ごとに72文字以下で、襟は自動改行をサポートせず、直接改行する必要があります.

    🗡 footer

    <footer>は、同じ参照情報を追加するための脚注です.(イベントトレーサIDを参照)
    たとえば、特定のイベントを参照するにはclose#1233を追加します.
    closeは、ホットスポットを参照してプライマリブランチにプッシュするときにホットスポットを閉じます.

    ⚔▼メッセージの送信例



    Reference

  • https://xtring-dev.tistory.com/entry/Git-使用ルール-Commit-メッセージ-開発チーム-コラボレーション-👾 [xtring.dev]
    • ubuntu 1604置換ソース
    Thread