React Router への貢献
貢献ありがとうございます！
オープンソースにおいては、さまざまな種類の貢献が可能であり、そのすべてが価値のあるものです。貢献を準備する際に役立ついくつかのガイドラインを以下に示します。
Open Governance モデル
先に進む前に、React Router でバグ/issue/機能提案をどのように扱っているかに関する情報について、Open Governance のブログ記事とドキュメントをお読みください。
セットアップ
コードベースに貢献する前に、リポジトリをフォークする必要があります。これは、どのような種類の貢献をするかによって少し異なります。
- すべての新しい機能、バグ修正、または
react-routerのコードに触れるもの は、devブランチから分岐して、devブランチにマージする必要があります。 - ドキュメントのみに触れる変更は、
mainブランチから分岐して、mainブランチにマージできます。
以下の手順で、このリポジトリへの変更に貢献するための準備ができます。
-
リポジトリをフォークします（このページの右上にある Fork ボタンをクリックします）
-
フォークしたリポジトリをローカルにクローンします。
# ターミナルで、クローンを作成したい親ディレクトリに cd してから git clone https://github.com/<your_github_username>/react-router.git cd react-router # *何らかの* コード変更を行う場合は、必ず dev ブランチをチェックアウトしてください git checkout dev -
依存関係をインストールしてビルドします。React Router は pnpm を使用しているので、あなたもそうすべきです。
npmを使用してインストールすると、不要なpackage-lock.jsonファイルが生成されます。
バグを見つけたと思いますか？
issue テンプレートに従い、最小限で実行可能な再現手順を提供してください。最も良いのは、失敗するテスト を含むプルリクエストです。次に良いのは、バグを示す StackBlitz、CodeSandbox、または GitHub リポジトリへのリンクです。
Issue が注目されていない？
バグを修正する必要があるのに、誰も修正していない場合は、自分で修正して プルリクエスト を作成するのが最善です。オープンソースコードは私たち全員のものであり、それを前進させるのは私たち全員の責任です。
新しい API または変更された API を提案しますか？
⚠️ 新機能の PR から始めないでください。
新機能は、Open Governance モデル で概説されているプロセスを経る必要があり、GitHub で提案に関するディスカッションを開くことから始めることができます。React Router をアプリでどのように使用したいかを示す、思慮深いコメントとサンプルコードを提供してください。変更または追加する必要があるものについて結論を急ぐ前に、現在の API によってどのように制限されているかを示すことができれば、議論がしやすくなります。
私たちは経験から、小さな API の方が通常は優れていることを学んだので、現在の API に明らかな制限がない限り、何か新しいものを追加することには少し抵抗があるかもしれません。とは言え、私たちがこれまで考慮していなかったケースについてお聞きするのはいつでも大歓迎ですので、遠慮なくお申し付けください！ :)
例を追加しますか？
例は、main ブランチに直接追加できます。ローカルにクローンした main からブランチを作成します。完了したら、プルリクエストを作成し、例の概要を説明します。
プルリクエストを作成しますか？
プルリクエストをマージするには、2 人以上の共同作業者の承認が必要です。PR 作成者が共同作業者の場合、それは 1 人としてカウントされます。
dev ブランチにする必要があります。GitHub で PR を作成するときに、「変更の比較」見出しの下にあるドロップダウンでベースを設定します： 
テスト
バグを修正したり、機能を追加したりするすべてのコミットには、テストが必要です。
ドキュメント + 例
API を変更または追加するすべてのコミットは、関連するすべての例とドキュメントも更新するプルリクエストで行う必要があります。
ドキュメントは docs ディレクトリにあります。変更が main ブランチに反映されると、ドキュメントサイトに自動的に公開されます。
ドキュメントサイトでの変更の見え方を確認したい場合は、react-router-website リポジトリ をクローンし、README.md の指示に従ってローカルで変更を表示します。
開発
パッケージ
React Router は、複数のパッケージのコードをホストするためにモノレポを使用します。これらのパッケージは packages ディレクトリにあります。
pnpm ワークスペース を使用して、依存関係のインストールとさまざまなスクリプトの実行を管理します。すべてをインストールするには、pnpm がインストールされている ことを確認してから、リポジトリのルートから pnpm install を実行します。
ビルド
ルートディレクトリから pnpm build を呼び出すと、ビルドが実行されます。これは数秒しかかかりません。個々のパッケージは相互に依存関係があるため、すべてのパッケージをまとめてビルドすることが重要です。
テスト
テストを実行する前に、ビルドを実行する必要があります。ビルド後、ルートディレクトリから pnpm test を実行すると、すべての パッケージのテストが実行されます。特定のパッケージのテストを実行する場合は、pnpm test packages/<package-name>/ を使用します。
# すべてのパッケージをテストする
pnpm test
# @react-router/dev のみをテストする
pnpm test packages/react-router-dev/リポジトリのブランチ
このリポジトリは、さまざまな目的のために個別のブランチを維持します。それらは次のようになります。
- main > 最新のリリースと現在のドキュメント
- dev > 安定版リリース間のアクティブな開発中のコード
- v6 > 特定のメジャーリリースの最新コード
さまざまな機能や実験のための他のブランチがあるかもしれませんが、すべての魔法はこれらのブランチから起こります。
リリース
リリースプロセスのアウトラインについては、DEVELOPMENT.md を参照してください。