Versions

Contributing

开源项目的一个伟大之处在于任何人都可以以任何有意义的方式作出贡献。ESLint 的存在离不开自项目开始以来众多贡献者的帮助,我们希望你能感觉到你也能做出贡献并有所作为。

本指南是为任何想为 ESLint 项目作出贡献的人准备的。请仔细阅读,因为它回答了许多新人在第一次与我们的项目合作时遇到的很多问题。

阅读行为准则

ESLint 欢迎每个人的贡献,并遵守 OpenJS 基金会的行为准则。我们恳请您在投稿前仔细阅读我们的行为准则。

错误报告

你认为你发现了一个问题?我们很乐意听到这个问题。本节解释了如何提交一个 bug,我们需要什么样的信息来正确验证它,以及整个过程。

提议新规则

我们在 ESLint 中收到很多关于新规则的提议。本节解释了我们如何确定哪些规则被接受,以及你应该提供哪些信息来帮助我们评估你的建议。

提议规则修改

想对现有的规则进行修改?本节解释了这一过程以及我们如何评估此类提案。

请求修改

如果你想请求一个除错误修复或新规则之外的变化,本节将解释这一过程。

报告安全漏洞

要报告 ESLint 的安全漏洞,请使用我们的 HackerOne 程序

专注议题

有一些额外的时间并想做出贡献?本节讲述了在议题上工作的过程。

提交拉取请求

我们一直在寻找来自社区的贡献。本节解释了拉动请求的要求和贡献代码的过程。

签署 CLA

为了向 ESLint 项目提交代码或文档,你需要以电子方式签署我们的贡献者许可协议。CLA 是常用的 Apache 风格的模板,它是你给我们使用你的贡献的许可。对于任何使用 EasyCLA 的 OpenJS 基金会项目,你只需要签署一次 CLA。在您打开的第一个拉动请求中,您将被要求签署 CLA。