跳至主要内容

贡献

感谢您想要贡献。

为了帮助,您可以

您不仅会帮助 Stylelint 蓬勃发展,而且您可能会学到一两件事——关于 CSS、PostCSS、Node.js、单元测试、开源软件等等。我们希望鼓励贡献!如果您想参与但无法参与,请 给我们反馈 关于我们如何做得更好。

代码贡献

要开始编码,您需要

然后

  1. Fork 和克隆 Stylelint 仓库。
  2. 使用 npm install 安装所有依赖项。

运行测试

接下来,您需要使用 npm test 运行测试。

但是,这会运行所有 25,000 多个单元测试以及代码风格检查。

您可以使用交互式测试提示仅为一组选定的文件运行测试(您在开发过程中需要这样做)。例如,要仅为 unit-allowed-listunit-disallowed-list 规则运行测试

  1. 运行 npm run watch 以启动交互式测试提示。
  2. p 以按文件名正则表达式模式过滤。
  3. 输入 unit-allowed-list|unit-disallowed-list,即每个规则名称用管道符号 (|) 分隔。

您可以在 Jest 网站 上找到有关测试的更多信息。

编写代码

在交互式测试提示运行时,您可以自信地编写代码,确保一切按预期工作。

您可以编写代码来

格式化代码

我们使用 Prettier(带有 Husky 和 lint-staged precommit)来自动格式化您的代码。

或者,您可以

打开拉取请求

当您有要分享的东西时,是时候 打开拉取请求 了。

在我们审查并合并您的拉取请求后,我们将邀请您成为 Stylelint 组织的维护者。然后,您将能够帮助管理问题、拉取请求和发布。您还可以直接在 Stylelint 仓库上工作,而不是您的 fork。

财务贡献

我们在我们的 Open Collective 上以完全透明的方式欢迎财务贡献。

任何人都可以提交费用。如果费用对社区的发展有意义,我们将将其“合并”到账簿中。然后,Open Collective 会报销提交费用的人员。

您可以通过成为以下人员来为我们提供财务支持: