始めに

コミットのルールについて学ぼう

1 min read
177 words

私たちはクリーンなプロジェクト履歴を持ちたいと思っています。私たちのコミット規約は Conventional Commits からインスパイアを受けていますが、gitmoji を使ってもっと視覚的で楽しいものにカスタマイズしています。

構造

コミットメッセージは以下のように構成され、小文字であるべきです:

<gitmoji> <type> <description> [(#<issue number>)]

[optional body]

[optional footer(s)]

📝 update documentation contributors

- Add @jerembdn as a contributor
- Add @younesbessa as a contributor

Co-authored-by: Younes Bessa <[email protected]>

ほとんどの場合、シンプルなワンライナーで十分です:

📝 update documentation contributors

タイプ

私たちは以下のコミットタイプを使用します:

TypeDescription
add新しい機能を追加
fixバグを修正
improve何かを改善
update何かを更新
remove何かを削除
refactor何かをリファクタリング
rename何かの名前を変更
moveファイルやフォルダを移動
upgrade依存関係をアップグレード
downgrade依存関係をダウングレード

説明

説明は命令形小文字で書いてください:

# 良い
📝 update documentation contributors

# 悪い
📝 updated documentation contributors

# 悪い
📝 Update documentation contributors

イシュー番号

コミットをイシューにリンクさせるためにイシュー番号を追加します:

📝 update documentation contributors (#123)

本文

本文はコンテキストと動機のために使います:

📝 update documentation contributors

- Add @jerembdn as a contributor
- Add @younesbessa as a contributor

Co-authored-by: Younes Bessa <[email protected]>

一つのコミット、一つの目的

各コミットは単一の論理的変更を表すべきです。無関係な変更を混ぜないでください。