プロジェクトガイド

オープンソースリポジトリ向け CONTRIBUTING.md テンプレート

CONTRIBUTING.md は「手伝いたい」という気持ちを、有用な Issue や Pull Request につなげます。受け入れられる最小限の貢献と確認方法を説明しましょう。要件は誰も守らない理想のプロセスではなく、プロジェクトの実際の運営を反映させます。

GitHubStart 編集チーム · 更新日

貢献テンプレートをコピーして調整する

プレースホルダーを置き換え、すべてのコマンドとリンクを確認します。アプリケーションコードの変更にまだ不慣れな人にも、文書の訂正やバグ報告を歓迎しましょう。

# 貢献について

## 始める前に
README を読み、既存の Issue を確認してください。
大きな変更は実装前に方針を相談してください。

## ローカル環境の準備
[必要なランタイムと確認済みのセットアップコマンド]

## バグを報告する
バージョン、環境、手順、期待した結果、実際の結果を含めてください。
ログから秘密情報と個人情報を除いてください。

## Pull Request を提出する
- 問題と提案する変更を説明します。
- 変更の範囲を絞ります。
- [プロジェクト固有のチェック]を実行します。
- 影響するドキュメントを更新します。

## レビュー
[レビュー担当者、応答方法、現実的な対応可能時間]

## その他の協力方法
[ドキュメント、例、翻訳、再現可能な報告]

ガイドを見つけやすくする

GitHub はリポジトリのルート、docs、.github ディレクトリにある貢献ガイドを認識します。README からもリンクし、紹介文を読んだ人がすぐに手順を見つけられるようにします。

実際の貢献の入口からたどれる経路を確認します。ガイドが複数あるなら矛盾する説明を整理してください。README にあるセットアップコマンドと、貢献ガイドの未対応コマンドが食い違う状態にしないようにしましょう。

取り組みやすい最初の貢献を一つ設計する

対応ランタイム用の例を修正するなど、結果が明確な小さな作業を選びます。問題の再現方法、変えるべき動作、完了の確認方法を説明します。文書化されていない内部知識が必要な作業を、初心者向けと表示しないでください。

レビューに使える時間は正直に伝えます。応答期限を約束できないなら、貢献者が進捗を確認する方法を示します。明確な境界は作業の放置を減らし、すべての貢献をマージすると約束するより役立ちます。

よくある質問

CONTRIBUTING.md は README.md の代わりになりますか?

いいえ。README はプロジェクトと使い方を説明し、貢献ガイドは変更の提案と確認方法を説明します。

他のプロジェクトのテストコマンドをコピーすべきですか?

自分のプロジェクトにも正しいコマンドである場合に限ります。実際に確認したコマンドでプレースホルダーを置き換えてください。

貢献ガイドがあれば貢献者は必ず増えますか?

いいえ。関心のある人の不安は減らせますが、プロジェクトの有用性、作業の質、メンテナーのフォローも重要です。

参考資料