mcpField
C
changelog

changelog

github.com/cloudflareドキュメント5.4k96 回インストール今日更新
リポジトリ

changelog について

changelog は、プロジェクトの変更履歴エントリーを作成、編集、レビューするスキルです。技術ライターや開発者向けに、製品フォルダーの選定、必要な背景情報、書式、コード例、ドキュメントリンクを案内します。

主な機能

  1. 01指定パスへの変更履歴エントリー作成
  2. 02製品フォルダーと必要情報の確認
  3. 03frontmatterとスタイル規則の適用
  4. 04APIや設定変更にコード例を追加
  5. 05リンクとエントリー品質のレビュー

活用シーン

  1. 01製品機能や変更の記録
  2. 02既存の変更履歴エントリーの編集
  3. 03エントリーの構成とスタイルの確認

インストール

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

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

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

詳細

src/content/changelog/ の変更履歴エントリーを作成、編集、またはレビューするときに、このスキルを使用します。

スタイルの参考資料： .agents/references/style-guide.md には、文体、書式、リンク、コードブロック、フロントマターに関する標準ルールが記載されています。以下の変更履歴固有の追加ルールは、これらのルールを拡張するものであり、置き換えるものではありません。

前提条件

執筆する前に、次の3つが必要です。

  1. 製品名（例：Workers、KV、Hyperdrive、Containers、R2）
  2. 記録する変更の説明
  3. 「なぜ」とユースケースを説明するための十分な背景情報

いずれかが不足している場合は、詳細を確認してください。3つすべてが揃うまで作業を進めないでください。

製品フォルダーを特定する

製品名を使って、src/content/changelog/{product}/ 以下の正しいフォルダーを見つけます。有効な製品名を確認するため、既存のフォルダーを調べてください。推測しないでください。

変更履歴ファイルを作成する

パス形式：

src/content/changelog/{product}/{YYYY-MM-DD}-{useful-short-name}.mdx

今日の日付と、変更内容を表す簡潔なハイフン区切りのスラッグを使用します。

フロントマター

---
title: <TITLE>
description: <ONE_SENTENCE_SUMMARY>
products:
  - <PRODUCT>
date: <YYYY-MM-DD>
---

執筆スタイル

.agents/references/style-guide.md のルールに従ってください。変更履歴固有の追加ルール：

  • 冒頭の文では、その機能や変更の内容と、解決する問題を説明します
  • 続く段落では、使い方、ユースケース、「なぜ」を詳しく説明します
  • 技術に詳しい開発者やクラウド利用者を想定します

コード例

変更履歴で API、SDK、または設定の変更を説明する場合は、コード例を含めます。

  • スニペットは短く、新機能に焦点を絞り、定型コードは最小限にします
  • フロントマターの後にコンポーネントをインポートします：import { TypeScriptExample, WranglerConfig } from "~/components";
  • Workers JS/TS → js/ts のコードフェンスではなく、TypeScriptExample を使用します
  • Wrangler の設定 → TOML 入力と compatibility_date の $today を使用する WranglerConfig を使用します（toml/jsonc のコードフェンスは使用しません）
  • その他の言語（Python、Rust、Go など）→ 正しい言語識別子を指定した通常のコードフェンスを使用します
  • Workers 以外の設定スニペット（JSON、YAML など）→ 通常のコードフェンス（json、yaml など）を使用します

ドキュメントへのリンク

変更履歴の最後に、関連ドキュメントへのリンクを記載します。

  • 相対パスを使用します（例：/workers/configuration/placement/）
  • リンクテキストにはリンク先の内容を記述します。「ここをクリック」や「続きを読む」は使用しないでください
  • 関連ドキュメントとなる可能性のある、未コミットまたはステージ済みの .md/.mdx ファイルを確認します

参考例

文体と形式を確認するため、次の既存の変更履歴を参照してください。

  • src/content/changelog/workers/ - コード例を含む Workers の変更履歴
  • src/content/changelog/kv/ - KV の変更履歴
  • src/content/changelog/hyperdrive/ - Hyperdrive の変更履歴
  • src/content/changelog/containers/ - Containers の変更履歴

執筆前に、対象製品の変更履歴フォルダーにあるエントリーを2～3件読んで、文体や詳しさを合わせます。対象フォルダーのエントリーが2件未満の場合は、参考として上記のフォルダーを参照します。

既存エントリーの編集

既存の変更履歴エントリーを更新する場合は、元の構成と文体を維持します。依頼された変更のみを適用し、周辺の内容を書き直さないでください。

変更履歴エントリーのレビュー

レビュー時は、上記のすべての項目に照らして、フロントマターのフィールド、ファイルパスの規則、執筆スタイル、コード例の品質、ドキュメントへのリンクを確認します。問題は重大度別に指摘します。

  • エラー：必須のフロントマターフィールドがない、製品フォルダーが間違っている、リンクが壊れている
  • 警告：スタイル違反、API の変更に対するコード例がない、説明が曖昧
  • 軽微な指摘：表現の小さな改善

出力

変更履歴ファイルを作成または更新し、ファイルの完全なパスと内容を表示します。

コメント

Markdown 対応