効果的なContributingセクションの書き方

機能するContributingセクションを書く

よく書かれたContributingセクションは、新しい貢献者の参入障壁を下げます。開発環境のセットアップ方法、コード基準、変更の提出方法に答える必要があります。

開発セットアップ

完全なコピー＆ペースト可能なセットアップ手順を提供します：

1. リポジトリをフォーク
2. フォークをクローン
3. 依存関係をインストール
4. ブランチを作成

コードスタイルガイドライン

フォーマットの期待について具体的にしてください：

• リンティング：ESLintを使用。コミット前にnpm run lintを実行
• フォーマット：Prettierが設定済み
• コミット：Conventional Commits形式に従う
• テスト：すべての新機能にテストを含める

プルリクエストプロセス

正確なステップを概説します：

1. すべてのテストが通過することを確認
2. 動作が変更された場合はドキュメントを更新
3. PRテンプレートに完全に記入
4. 少なくとも1人のメンテナからレビューを依頼

歓迎される貢献の種類

バグレポート、機能リクエスト、ドキュメント、コード、翻訳など、求めている貢献を明示的に述べてください。

初めての貢献者

初めての貢献者への歓迎のメモを追加し、good first issueラベルでイシューを分類して適切なタスクを見つけやすくしてください。