概述

感谢您对 Rspack 贡献的兴趣!每一次贡献都至关重要,并帮助我们将 Rspack 推向新的高度。

提问

如果您有任何问题,请随时在 Discord 支持频道或 GitHub 讨论版 上提问。

最小可复现示例

您可以使用 Rspack repro 模板 创建一个最小可复现示例。

最小可复现示例 (MRE) 是一个代码,它

  • 简短
  • 自包含
  • 演示遇到的问题

MRE 至关重要,因为它使我们能够快速理解和复现您的问题。这反过来又会增加在更短的时间内获得有益且准确回复的可能性。重要的是要注意,MRE 不应包含与无关功能相关的多余代码,而应专注于手头的难题。

另请参阅 Stack Overflow 上的 如何创建一个最小可复现示例

我应该做什么?

新手友好问题

如果您希望深入代码库并开始贡献,我们建议您查看我们标记为 新手友好问题 的问题列表。这将帮助您熟悉项目并开始贡献。

跟踪问题

如果您有兴趣了解我们项目的进展方向,并希望致力于符合我们优先事项的问题,我们的 跟踪问题列表 提供了我们进度和当前目标的概述。

发送拉取请求

  1. Fork Rspack 仓库到您自己的 GitHub 帐户中。
  2. 克隆 仓库到本地。
  3. main 分支检出一个新分支。
  4. 设置开发环境,您可以阅读 先决条件 部分以了解它。
  5. 如果您修复了一个错误或添加了需要测试的代码,请添加一些测试。
  6. 确保所有测试都通过,您可以阅读下面的 测试 部分以了解它。
  7. 运行 pnpm run lint:jspnpm run lint:rs 检查代码风格。
  8. 提交拉取请求,确保所有 CI 运行都通过。
  9. 维护者将很快审核您的拉取请求。

在提交拉取请求时,请注意以下事项

  • 保持您的 PR 足够小,以便每个 PR 只解决一个问题或添加一个功能。
  • 请在 PR 中包含适当的描述,并链接相关问题。

PR 标题格式

PR 标题格式遵循 规范提交

示例

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

其他贡献方式

我们一直在寻找贡献者,这不仅限于我们的主要仓库。

查看这些其他参与方式,并从今天开始做出改变。


请记住,所有贡献者都应遵循我们的 行为准则