概要

Rspackへの貢献にご興味をお持ちいただきありがとうございます!すべての貢献は重要であり、Rspackを次のレベルに引き上げるのに役立ちます。

質問をする

ご質問がある場合は、DiscordサポートチャンネルまたはGitHubディスカッションボードでお気軽にご質問ください。

最小限の再現

Rspack再現テンプレートを使用して、最小限の再現可能な例を作成できます。

最小限の再現可能な例(MRE)とは、以下の条件を満たすコードです。

  • 短い
  • 自己完結型
  • 発生している問題を示している

MREは、問題を迅速に理解し、再現できるようにするために不可欠です。これにより、より短い時間で役立つ正確な回答を得られる可能性が高まります。MREには、無関係な機能に関連する無関係なコードを含めるべきではなく、代わりに目の前の問題のみに焦点を当てる必要があることに注意することが重要です。

Stack Overflowの最小限の再現可能な例の作成方法も参照してください。

何に取り組むべきか?

初心者向けイシュー

コードベースに飛び込んで開始したい場合は、good first issueのラベルが付いたイシューリストを確認することをお勧めします。これにより、プロジェクトに慣れ、貢献を開始するのに役立ちます。

追跡イシュー

プロジェクトの方向性を理解し、優先順位に沿ったイシューに取り組みたい場合は、追跡イシューリストで進捗状況と現在の目標の概要を確認できます。

プルリクエストを送信する

  1. Rspackリポジトリを自分のGitHubアカウントにフォークします。
  2. リポジトリをローカルにクローンします。
  3. mainから新しいブランチをチェックアウトします。
  4. 開発環境をセットアップします。前提条件セクションを読んで、詳細を確認してください。
  5. バグを修正した場合、またはテストが必要なコードを追加した場合は、テストを追加してください。
  6. すべてのテストに合格していることを確認します。以下のテストセクションを読んで、詳細を確認してください。
  7. pnpm run lint:jspnpm run lint:rsを実行して、コードスタイルを確認します。
  8. プルリクエストを送信します。すべてのCIがパスしていることを確認してください。
  9. メンテナーがプルリクエストをすぐにレビューします。

プルリクエストを送信する際には、以下の点に注意してください。

  • PRは、各PRが1つの問題のみを addressedしたり、1つの機能のみを追加するように、十分に小さくしてください。
  • PRには適切な説明を含め、関連するイシューにリンクしてください。

PRタイトルの形式

PRタイトルの形式は、Conventional Commitsに従います。

例:

feat(core): Add `fooBar` config
^    ^      ^
|    |      |__ Subject
|    |_______ Scope (optional)
|____________ Type

PRに破壊的変更が含まれている場合は、タイプ/スコープの後に!を追加し、release: breaking change GitHubラベルを追加してください。

fix!: remove deprecated `fooBar` config
fix(core)!: remove deprecated `fooBar` config

その他の貢献方法

私たちは常に貢献者を探しており、それはメインリポジトリだけにとどまりません。

今日から参加して変化を起こすための、その他の方法をご覧ください。


注意として、すべての貢献者は行動規範に従う必要があります。