変更履歴テンプレート

Keep a Changelogの規約に従った、ソフトウェアプロジェクトの変更履歴テンプレート。

# Changelog Template: プロフェッショナルなプロジェクトドキュメントのための必須ツールキット ソフトウェアプロジェクトの維持管理は、単にコードを書くことだけではありません。それは、あなたの成果がどのように進化しているかをユーザーや貢献者、そして未来の自分自身に伝えることです。しかし、多くの開発者にとってCHANGELOG.mdファイルの更新は、リリース時に慌てて行う後付けの作業になりがちです。Chrome拡張機能「Changelog Template」は、このギャップを埋めるために開発されました。業界標準の規約に沿った高品質なチェンジログを維持するための、合理的で直感的、かつプロフェッショナルなワークフローを提供します。 ## 核心的な目的: 「Keep a Changelog」によるコミュニケーションの向上 Changelog Templateは、「Keep a Changelog」の規約を遵守することをサポートするツールです。優れたチェンジログとは、プロジェクトの各バージョンにおける注目すべき変更を、時系列順に厳選して記録したリストのことです。Gitのコミットメッセージをそのまま羅列したものではなく、人間が読むためのドキュメントです。 この拡張機能を使用することで、プロジェクトの履歴が読みやすく、整理され、有用なものになります。小規模なサイドプロジェクトから大規模なオープンソースライブラリ、内部ツールまで、Changelog Templateは開発サイクルに負担をかけることなく、透明性とプロフェッショナリズムを維持するための構造を提供します。 ## 信頼できる標準化されたフォーマット この拡張機能は標準的なチェンジログ形式に厳密に準拠しており、ドキュメントがプロフェッショナルな外観を保ち、より広いエコシステムと互換性を持つことを保証します。作成するすべてのエントリは、「Keep a Changelog」プロジェクトが推奨する6つの標準的な変更タイプに分類されます。 1. **Added:** ソフトウェアの機能を拡張する新機能。 2. **Changed:** 既存機能の動作を変更するもの。 3. **Deprecated:** 削除予定の機能。ユーザーに移行を促すための通知。 4. **Removed:** コードベースから公式に削除された機能。 5. **Fixed:** 問題を解決し、安定性を向上させるバグ修正。 6. **Security:** 脆弱性に対処する重要なパッチ。 この分類により、ユーザーはリリースノートを素早く確認し、新しいツールを探しているのか、特定のバグが修正されたかどうかを知りたいのかをすぐに見つけることができます。 ## 効果的なエントリを書くためのガイドライン 優れたチェンジログを書くことは芸術です。技術的な正確さとアクセシビリティのバランスが必要です。Changelog Templateはテキストボックスを提供するだけでなく、重要なエントリを書くための文脈とガイダンスを提供します。 私たちは3つのシンプルなルールを推奨します: - **一文で書く:** 簡潔にしましょう。密度の高いパラグラフよりも、エントリごとに1つの明確なポイントを記載する方が優れています。 - **過去形で書く:** 「何が変わったか」を記述します（「Improved search performance」のように、「Improve search performance」とはしません）。 - **ユーザーの視点に立つ:** コードを書いた人ではなく、ソフトウェアを使う人のために書きましょう。「Refactored the SQL query optimizer（SQLクエリ最適化エンジンをリファクタリング）」と書く代わりに、「Improved search performance by 50%（検索パフォーマンスを50%向上）」と書くべきです。 この拡張機能は、エントリの自動大文字変換や、忘れがちなピリオドの自動付加など、細かい作業もサポートします。 ## 機能豊富なワークスペース Changelog Templateには、ドキュメント作成が自然なワークフローの一部に感じられるような機能が詰まっています。 ### 1. クイックエントリ作成 「Create」タブがメインエリアです。変更タイプを選択し、エントリを入力して「Add to Unreleased」をクリックするだけです。これほど簡単です。IDEとMarkdownファイルの間でコンテキストを切り替えて更新内容をメモする必要はもうありません。 ### 2. 「Unreleased」の永続管理 優れたチェンジログの最も強力な機能の一つは「Unreleased」セクションです。これは、最後の公式バージョン以降に行われたすべての変更のステージングエリアとして機能します。Changelog Templateはこのセクションを管理し、ローカルストレージに保存するため、拡張機能を開くたびにいつでも作業を再開できます。 ### 3. セマンティック・バージョニング (SemVer) リファレンス バージョニングは推測で行うべきではありません。「Reference」タブにはセマンティック・バージョニングのクイックスタートガイドが含まれており、次のリリースがメジャー、マイナー、パッチのどれであるかを判断する助けになります: - **MAJOR:** 非互換なAPIの変更がある場合。 - **MINOR:** 後方互換性のある機能を追加した場合。 - **PATCH:** 後方互換性のあるバグ修正を行った場合。 ### 4. 自動化ツールリファレンス 次のステップへ進みたいチームのために、`standard-version`、`release-it`、`semantic-release`といった業界標準の自動化ツールを紹介しています。これらのツールは、拡張機能が生成するMarkdown形式と連携し、リリースプロセス全体を自動化できます。 ### 5. ワンクリックコピーとMarkdownエクスポート ファイルを更新する準備ができたら、ワンクリックで「Unreleased」セクションを整形済みのMarkdownとしてコピーできます。新しいプロジェクトを始める場合は、「Full CHANGELOG.md Starter Template」を使って、必要なヘッダーとリンクが含まれた完全なボイラープレートファイルを生成してください。 ## なぜ優れたチェンジログが重要なのか 適切に管理されたチェンジログは、単なる更新リスト以上のものです。それは、健全で成熟したプロジェクトであることの証です。ユーザーに対し、プロジェクトが積極的に維持されていることを示すことで「透明性」を構築します。何百ものコミットメッセージに埋もれてしまう可能性のある重要な変更を強調することで「コミュニケーション」を促進します。何よりも、それは「プロフェッショナリズム」を証明します。きれいに整理されたCHANGELOG.mdを見たユーザーは、そのプロジェクトと開発者を信頼できると確信します。 ## このツールは誰のためのもの？ - **ソロ開発者:** サイドプロジェクトを整理し、「3ヶ月前に何をしたっけ？」という瞬間を回避しましょう。 - **小規模チーム:** すべての小さな更新に複雑なJiraボードを必要とすることなく、プロジェクトの進捗に関する認識を合わせましょう。 - **オープンソース貢献者:** 明確で読みやすいリリースノートを提供することで、プロジェクトに新しいユーザーを招き入れましょう。 ## 使いやすさ: 設定不要、面倒なし Changelog Templateは、必要な時以外は邪魔にならないように設計されています。複雑なセットアップや外部アカウントの作成、APIキーの管理は一切不要です。Chromeのローカルストレージを使用してデータをプライベートに保ち、自分のマシン上でのみアクセスできるようにします。UIはミニマリストで応答性が高く、ブラウザのサイドバーやポップアップエリアに最適にフィットします。 プロジェクトのドキュメントが遅れていくのを放置してはいけません。今すぐ「Changelog Template」を使い始めて、あなたのソフトウェアにふさわしいプロフェッショナルな履歴を与えましょう。