mcpField
D
docs-changelog

docs-changelog

github.com/petekp開発1039 回インストール21 週間前に更新
リポジトリ

docs-changelog について

docs-changelogは、直近のコミットを確認し、Keep a Changelog形式の分類済み更新を作成するドキュメントスキルです。ファイルの特定からバージョン選定、結果の検証まで案内します。

主な機能

  1. 01一般的な場所から変更履歴ファイルを検索
  2. 02最新バージョンと日付を解析
  3. 03コミットを確認して変更を分類
  4. 04Keep a Changelog形式で項目を作成
  5. 05項目の順序とバージョンリンクを検証

活用シーン

  1. 01最近のコミットからリリース項目を作成
  2. 02変更を標準カテゴリに整理
  3. 03変更履歴の書式とリンクを確認

インストール

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

$npx skills add https://github.com/petekp/agent-skills --skill docs-changelog

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

詳細

ドキュメントの変更履歴

最後に記録された項目以降のコミットを確認し、変更を分類して、Keep a Changelog 形式で適切に記述した項目を追加します。

ワークフロー

1. 変更履歴ファイルを探す

一般的な場所で変更履歴ファイルを検索します。

CHANGELOG.md
changelog.md
docs/changelog.md
docs/CHANGELOG.md
src/pages/changelog.md
src/content/changelog.mdx
content/changelog.md

標準的な場所で見つからない場合は、**/changelog.{md,mdx} や **/CHANGELOG.{md,mdx} のようなパターンで glob を使います。候補が複数ある場合は、どのファイルを使うかユーザーに尋ねます。

2. 最後の項目を解析する

変更履歴ファイルを読み、最新のバージョン見出しを抽出します。見出しの形式は次のとおりです。

## [X.Y.Z] - YYYY-MM-DD

以下を抽出します。

  • バージョン番号（例：1.2.0）— 次のバージョンを決めるために使用します
  • 日付（例：2025-01-15）— git log の対象範囲を決めるために使用します

変更履歴が空、または [Unreleased] 見出ししかない場合は、リポジトリの最も古いタグまたは最初のコミットを境界として使用します。

3. コミットを収集する

次を実行します。

git log --oneline --no-merges --after="YYYY-MM-DD" HEAD

YYYY-MM-DD には、最後の変更履歴項目の日付を指定します。タグも確認します。

git tag -l --sort=-creatordate | head -5

最後の変更履歴項目より新しいタグがある場合は、それを新しいバージョン番号として使用します。ない場合は、この項目に使用するバージョンをユーザーに尋ねます。

4. 変更を分類する

各コミットを確認し、Keep a Changelog のカテゴリに分類します。

カテゴリ含める変更
追加新機能、新しいページ、新しい API エンドポイント
変更既存機能の更新、動作の変更、依存関係の更新
非推奨将来的な削除が予定されている機能
削除機能やページの削除、サポートの終了
修正バグ修正、誤字の訂正、リンク切れの修正
セキュリティ脆弱性へのパッチ、セキュリティの改善

分類のルール：

  • コミットメッセージが曖昧な場合は差分を読みます。コードが実際の変更を示します
  • 関連するコミットは1つの箇条書きにまとめます（例：誤字修正のコミットが3件ある場合は、「ドキュメント全体の誤字を修正」としてまとめます）
  • ユーザーに見える動作に影響しない限り、内部処理のみのコミット（CI 設定、lint、書式設定のみ）は省きます
  • マージコミットとバージョン更新のコミットは省きます
5. 項目を作成する

新しい項目を # Changelog 見出しの直下（または ## [Unreleased] がある場合はその直下）に挿入します。次の構成を厳守し、項目のないカテゴリセクションは省略します。

## [X.Y.Z] - YYYY-MM-DD

### Added

- Brief, human-readable description of what was added

### Changed

- Brief description of what changed

### Fixed

- Brief description of what was fixed

記述ルール：

  • 各箇条書きは過去形の動詞（Added、Updated、Fixed、Removed）で始まる1文にします
  • 開発者ではなく、ドキュメントサイトの利用者に向けて書きます
  • 役立つ場合は、関連ページや PR にリンクします。例：[Getting Started](/docs/getting-started) ページのリンク切れを修正しました
  • 項目はざっと確認しやすいようにし、段落や入れ子の箇条書きは使いません
  • 過去の項目を確認して、プロジェクトで使われている文体に合わせます
  • ユーザーから指定がない限り、項目の日付には今日の日付を使います
6. 検証する

項目を追加した後、次を確認します。

  • 項目が新しいものから順に並んでいること
  • プロジェクトで使用している場合は、ファイル末尾のバージョンリンク参照も更新されていること（例：[1.3.0]: https://github.com/org/repo/compare/v1.2.0...v1.3.0）
  • 最終ファイルを読み、書式に問題がないこと

タスクの完了とする前に、確認用として新しい項目をユーザーに提示します。

コメント

Markdown 対応