メインコンテンツまでスキップ

コントリビューションガイド

正式な貢献ガイドはリポジトリルートの CONTRIBUTING.md を参照してください。 このページはドキュメントサイト向けの要約版です。

River Reviewへの参加ありがとうございます。このプロジェクトでは以下の方針に沿ってプルリクエストやIssueを受け付けています。

私たちのOSS運営方針​

River Reviewは、現場の証拠と外部の知見をもとに改善案を検討します。新しいSkillや必須ルールの追加だけでなく、既存の手順の簡素化も提案できます。採用・適応・前提の変革・見送りの考え方は、実践進化方針を参照してください。既存の提出・承認・CI規則は引き続き有効です。

PRの基本方針​

  • 1つのPRは1つの目的に絞ること。複数の変更は分割して提出すること。

  • PRのタイトルと説明に、何を変更したのか、なぜ必要なのかを明確に書くこと。

  • 他のドキュメントやコードに影響する場合は、関連ファイルへのリンクを添えること。

コードとドキュメント​

  • ドキュメントは日本語で執筆すること(日本語版がソース・オブ・トゥルース)。英語版を用意する場合は同名で .en.md を付け、内容がずれたら日本語版を優先すること。

  • 技術用語は必要に応じて英語も例示すること。

  • スタイルガイドに従うこと(WRITING_GUIDE.mdを参照)。

  • レビュー用のラベルやチェックを追加・変更する場合はPDRに記録すること。

Issueの報告​

  • バグ報告や機能要望はIssueとして登録すること。

  • 再現手順や望ましい結果、実際の結果を具体的に書くこと。

Issue はテンプレートから作成してください(Issues → New issue、または issues/new/choose)。

ラベルの目安やトリアージ方針は pages/guides/governance/issue-management.md を参照してください。

みなさまのご協力に感謝します!