git-conventions について
git-conventionsは、リモート、コミットとPRのタイトル、worktree、文章の書き方に関する規約を定めるリポジトリ向けスキルです。Git運用と履歴の一貫性を保ちます。
主な機能
- 01ホスト別のリモート命名
- 02コミットとPRのタイトル形式
- 03worktreeの配置指針
- 04リポジトリの文章作法
活用シーン
- 01リポジトリのリモート設定
- 02コミットやPRのタイトル作成
- 03worktreeの配置場所の選択
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/インストール後、Claude Code で/git-conventionsを入力して読み込まれたか確認します。
同梱ファイルagents/openai.yamlskill.toml
詳細
Git の規約
リモート
- リモートにはホスト名を付けます。GitHub には
github、個人用 Forgejo インスタンスにはforgeを使います。originは使いません。 - 可能であれば両方のリモートを設定します。2 つ目はバックアップミラーとして機能します。
- 各リポジトリは、セットアップ時にプライマリリモートを 1 つ選びます。プライマリが CI とプルリクエストを管理し、会話で「origin」と呼ぶものにあたります。デフォルトのプライマリは
githubです。
コミットと PR のタイトル
1 行目は type(scope): description とし、scope は任意です。type は feat、fix、docs、ci、build、chore、refactor、test、perf、revert です。
ワークツリー
ワークツリーは任意です。手動で作成する場合は <repo>/.worktrees/<branch> に置き、ブランチ名のスラッシュはハイフンに置き換えます。このディレクトリは gitignore の対象にします。Claude Code の .claude/worktrees/ など、ハーネス標準のワークツリー用ディレクトリを使ってもかまいません。プロジェクトのフォルダーには、ワークツリーを裸の状態で並べて置かないでください。
文体
- ピリオドとカンマを使った平易な文にします。見出しは文頭のみ大文字にします。
- リポジトリの長期的な履歴として残すことを意識し、計画、マイルストーン、フェーズではなく、変更そのものを記述します。ブランチはマージ時に削除されるため、
m2/prngのようなスタックのプレフィックスを名前に残してもかまいません。 - エムダッシュや装飾的な絵文字は使いません。
コメント
Markdown 対応