GitHubリリースノートテンプレート
ハイライト、ダウンロードリンク、コントリビューターメンション、完全なチェンジログリンクを含むGitHubリリースノートのテンプレート。GitHubのリリースUIに最適化。
Templates
詳細な説明
GitHubリリースノートテンプレート
GitHub Releasesには従来のCHANGELOG.mdとは若干異なる独自の規約があります。リリースノートはリポジトリのReleasesページに表示され、Markdownフォーマット、@メンション、自動生成コンテンツを含むことができます。
GitHub固有の機能
- 自動生成ノート: GitHubはマージされたPRから自動的にノートを生成可能
- @メンション: コントリビューターを直接タグ（通知が届く）
- 比較リンク: 常に完全なチェンジログdiffリンクを含める
- アセット: バイナリファイル、インストーラー、アーカイブを添付
- プレリリースフラグ: alpha/beta/RCリリースを適切にマーク
ヒント
- バージョンにはH1を使用（リリースタイトルになる）
- 素早くスキャンできるよう「Highlights」セクションを上部に含める
- 主要機能には関連するディスカッションやRFCにリンク
- 便利なインストール/アップグレードコマンドを追加
ユースケース
GitHubのReleasesページでリリースを公開する場合。ノートがユーザーが変更内容を知る主要な方法となり、@メンションや比較リンクなどのGitHub固有の機能を適切に使用します。