mcpField
W
writing-git-commits

writing-git-commits

github.com/zenobi-us開発6836 回インストール今日更新
リポジトリ

writing-git-commits について

Conventional Commits に沿った、変更意図が人にもツールにも伝わるコミットメッセージの書き方を案内するスキルです。概要、例、仕様、FAQを収録しています。

主な機能

  1. 01Conventional Commits の形式と種類
  2. 02スコープと変更意図の指針
  3. 03SemVer とリリースツールの説明
  4. 04概要、例、仕様、FAQ

活用シーン

  1. 01チームで一貫したコミットを作成
  2. 02自動変更履歴生成向けのコミット作成
  3. 03SemVer に基づくリリースワークフローの支援

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/zenobi-us/dotfiles --skill writing-git-commits

インストール後、Claude Code で/writing-git-commitsを入力して読み込まれたか確認します。

詳細

優れた Git コミットの書き方

人にも機械にも意図が伝わる、意味のあるコミットメッセージを書く技術を身につけましょう。Conventional Commits の仕様に従ってコミットを作成すれば、自動化ツールに対応し、履歴を明確に保ち、効果的なコラボレーションを実現できます。

Conventional Commits とは？

Conventional Commits は、コミットメッセージに人と機械が読み取れる意味を付与するための、軽量な仕様です。次のような、明示的なコミット履歴を作成するためのシンプルなルールを定めています。

  • 自動化ツールがコミットを解析し、処理できるようにします
  • コードの履歴をひと目で把握しやすくします
  • 自動リリース管理に向けて、セマンティックバージョニング（SemVer）に準拠します
  • より整理された開発手法を促します

子スキル

  • 概要：仕様と主要な概念の簡単な説明

    • → ./summary/SKILL.md を参照してください
      • または、必要に応じて skill_use(superpowers_writing_git_commits_summary) を実行してください

  • 例：さまざまな状況における実際のコミットメッセージの例

    • → ./examples/SKILL.md を参照してください
      • または、必要に応じて skill_use(superpowers_writing_git_commits_examples) を実行してください

  • 仕様：すべてのルールと要件を含む技術仕様

    • → ./specification/SKILL.md を参照してください
      • または、必要に応じて skill_use(superpowers_writing_git_commits_specification) を実行してください

  • FAQ：よくある質問と実践的なガイダンス

    • → ./faq/SKILL.md を参照してください
      • または、必要に応じて skill_use(superpowers_writing_git_commits_faq) を実行してください

基本構造

すべてのコミットメッセージは、次の形式に従う必要があります。

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

主なコミットタイプ

  • feat：新機能を追加します（SemVer の MINOR に対応）
  • fix：バグを修正します（SemVer の PATCH に対応）
  • BREAKING CHANGE：後方互換性を破る大規模な変更です（SemVer の MAJOR に対応）
  • docs：ドキュメントの変更です
  • style：コードスタイルの変更です（書式設定、セミコロンの不足など）
  • refactor：機能を変更せずにコードをリファクタリングします
  • perf：パフォーマンスを改善します
  • test：テストを追加または更新します
  • chore：ビルド、依存関係、またはツールの変更です
  • ci：CI/CD 設定の変更です

このスキルを使う場面

次のような場合に、Conventional Commits の仕様を使用してください。

  • バージョン管理されたコードに対して、意味のあるコミットメッセージを作成するとき
  • 明確なコミット履歴を必要とするチームで作業するとき
  • コミットメッセージを解析する自動化ツールを構築するとき
  • セマンティックバージョニングの運用と統合するとき
  • CHANGELOG を自動生成するとき
  • 変更の内容を関係者に伝えるとき

適用方法

  1. 概要を読む：主要な概念をすばやく理解します
  2. 例を確認する：さまざまな状況がコミットタイプにどう対応するかを確認します
  3. 仕様を確認する：詳細なルールと技術要件を確認します
  4. FAQ を参照する：よくある質問への回答とベストプラクティスを確認します

主な原則

✅ 明確にする：コミットメッセージでは、何をなぜ変更したのかを明確に伝えます
✅ 一貫性を保つ：すべてのコミットで同じ規約を使用します
✅ 構造化する：タイプ／スコープ／説明の形式に従います
✅ 変更を分割する：可能な場合は、1 つのコミットにつき論理的な変更を 1 つにします
✅ 機械可読にする：自動化ツールによる処理と分析を可能にします

ワークフローとの統合

このスキルは /project:do:commit から参照され、明確で整理されたコミット履歴を保ち、リリース管理や変更履歴の生成に向けた自動化ツールを利用できるようにする、意味のあるコミットの作成を支援します。

ライセンス：Creative Commons - CC BY 3.0

出典：Conventional Commits v1.0.0

コメント

Markdown 対応