ミニマルなCONTRIBUTING.mdガイド

ミニマルなガイドで十分な場合

すべてのプロジェクトに20ページのコントリビューティングハンドブックが必要なわけではありません。個人プロジェクト、小規模ライブラリ、初期段階のオープンソースの取り組みでは、ミニマルなCONTRIBUTING.mdが障壁を作ることなく期待を設定します。

含めるべき内容

ミニマルなガイドは3つの要素をカバーすべきです：

1. バグの報告方法 -- 必要な情報（再現手順、期待される動作と実際の動作、環境の詳細）を伝えます。

2. 機能の提案方法 -- まずissueを開くことについて1〜2文で十分です。

3. コードの提出方法 -- Fork、branch、commit、PR。4つの箇条書きでワークフローをカバーします。

# Contributing

1. リポジトリをforkし、`main`からブランチを作成します。
2. 変更を加えます。
3. 明確な説明付きでプルリクエストを開きます。

省略すべき内容

コミットメッセージフォーマット、ブランチ命名規則、CLA要件、詳細なコードスタイルガイドのセクションは省略します。プロジェクトが成長したら後から追加できます。

アップグレードのタイミング

直接の知人以外からコントリビューションを受け始めた時、プロジェクトに複数の定期的なコントリビューターがいる時、またはプルリクエストレビューで同じフィードバックを繰り返している時にガイドの拡張を検討してください。