プロジェクトガイド

オープンソース向け GitHub リリースノートテンプレート

よいリリースノートは、アップグレードすべきか、次に何をすべきかを伝えます。マージ済み Pull Request の一覧は有用な根拠ですが、アップグレード体験全体を説明することはまれです。公開前にユーザーへの影響と必要な操作を補いましょう。

GitHubStart 編集チーム · 更新日

ユーザー中心のテンプレートから始める

角括弧の項目をすべて確認済みの情報に置き換えます。機能を作り上げず、無関係な節は削除してください。対応するアップグレード経路を確認し、操作が不要なら明記します。

# [バージョン] — [公開日]

## 主な変更
- [ユーザーに見える改善と対象者]

## アップグレード
- 移行元:[対応する旧バージョン]
- 操作:[必要な移行作業、または操作不要]
- 確認:[アップグレード成功の確認方法]

## 破壊的変更
- [変わった動作、影響を受けるユーザー、移行手順のリンク]

## 修正
- [解決した問題と Issue または Pull Request のリンク]

## 既知の問題
- [残る制限と回避策]

## 貢献者
[貢献者への謝辞と完全な変更履歴へのリンク]

生成されたノートを読みやすい説明にする

GitHub はマージ済み Pull Request、貢献者、完全な変更履歴のリンクを含むノートを生成できます。これを下書きとして扱い、リリースの対象範囲を確認し、無関係な項目を削除して、ユーザーの作業ごとに変更をまとめましょう。

たとえば「パーサーの境界ケースを修正」だけでは情報不足です。事実に合っているなら、最終列が空の CSV ファイルを正しくインポートできるようになったと説明し、技術的な詳細は修正へのリンクで示します。一つのケースだけを直したのに、すべての解析問題が解決したとは書かないでください。

告知前にアップグレード経路を確認する

対応する旧バージョンから、記載したアップグレードを試します。ダウンロードリンクを確認し、ドキュメントがリリースと一致しているか確かめます。プレビュー版と安定版を区別し、残る制限を見つけやすくします。

コミュニティ投稿からリンクする前に、リリース情報を公開します。告知では意味のある改善を一つ取り上げ、詳細な参照先にはリリースノートを使います。追加の質問を記録し、必要に応じて手順を明確にしましょう。

よくある質問

リリースノートと変更履歴は同じですか?

重なる部分はあります。変更履歴は時間に沿って変更を記録し、リリースノートは特定のリリースとユーザーへの影響を説明します。両者をリンクし、概要と詳細を行き来できるようにしましょう。

自動生成されたノートをそのまま公開してもよいですか?

先に確認してください。生成元の Pull Request タイトルには、移行手順、ユーザーへの影響、既知の問題が含まれていないことがあります。

小さなコード変更もすべて主な変更に含めるべきですか?

いいえ。ユーザーに重要な変更を取り上げ、技術的な詳細の履歴はリンク先の変更履歴に残します。

参考資料