オープンソースプロジェクトPRテンプレート

オープンソースプロジェクトPRテンプレート

オープンソースプロジェクトは、さまざまな経験レベルの開発者からコントリビューションを受けます。よく設計されたPRテンプレートは、コントリビューターに提出プロセスを案内し、完全でレビュー可能なPRの基準を明確に設定します。

テンプレート構造

## Description
<!-- 変更内容を詳細に記述してください。 -->

## Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Breaking change（以下に影響を記述してください）
- [ ] Documentation update
- [ ] Performance improvement
- [ ] Code refactoring
- [ ] Test improvement

## Checklist
- [ ] [CONTRIBUTING.md](CONTRIBUTING.md)ガイドラインを読んだ
- [ ] プロジェクトのコーディングスタイルに従っている
- [ ] 変更をカバーするテストを追加した
- [ ] すべての新規・既存テストが通過する
- [ ] ドキュメントを適切に更新した
- [ ] コミットにサインオフ済み（DCO）

## Breaking Changes
<!-- Breaking changeの場合、何が壊れるかとマイグレーションパスを記述してください。 -->

## Testing
<!-- メンテナーがどのように変更をテストできますか？ -->

CONTRIBUTING.md参照

チェックリストにはCONTRIBUTING.mdへのリンクが含まれています。このファイルは通常、コーディング規約、コミットメッセージのフォーマット、PRレビュープロセスをカバーします。

DCOサインオフ

多くのオープンソースプロジェクト（特にLinux Foundationプロジェクト）は、各コミットにDeveloper Certificate of Origin（DCO）サインオフを要求します。git commit -sフラグがSigned-off-by行を追加します。

コミュニティフレンドリーな言葉遣い

テンプレートは歓迎的な言葉遣いを使用し、HTMLコメントで明確な指示を提供しています。オープンソースプロジェクトでは、PRテンプレートがコントリビューターのプロジェクトプロセスとの最初のインタラクションになることが多いため、親しみやすいものであるべきです。

Breaking Changesセクション

ダウンストリームユーザーがマイグレーションガイダンスを必要とするオープンソースライブラリにとって、専用のBreaking Changesセクションは重要です。この情報はしばしばチェンジログやリリースノートに反映されます。