版本

贡献 ESLint

开源项目最棒的事情之一是任何人都可以通过多种有意义的方式做出贡献。如果没有自项目开始以来众多贡献者的帮助,ESLint 就不可能存在,我们也希望您觉得自己可以做出贡献并发挥作用。

本指南旨在为任何想要为 ESLint 项目做出贡献的人提供帮助。请仔细阅读,因为它回答了许多新手在首次使用我们的项目时遇到的问题。

阅读行为准则

ESLint 欢迎所有人的贡献,并遵守 OpenJS 基金会行为准则。我们恳请您在贡献之前阅读我们的行为准则。

报告错误

认为您发现了问题?我们很乐意了解。本节介绍了如何提交错误报告、我们需要哪些类型的信息来正确验证错误以及整个流程。

提议新规则

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

提议规则更改

想要更改现有规则?本节介绍了流程以及我们如何评估此类提议。

请求更改

如果您想请求除错误修复或新规则之外的更改,本节将介绍该过程。

架构

了解 ESLint 项目的架构。

设置开发环境

为 ESLint 开发与在命令行上运行它有点不同。本节向您展示如何设置开发环境并让您准备好编写代码。

运行测试

ESLint 包含许多单元测试,以确保我们保持代码质量。本节介绍了如何运行单元测试。

处理问题

有一些空闲时间并想做出贡献?本节讨论了处理问题的过程。

提交 Pull Request

我们一直在寻找来自社区的贡献。本节介绍了 pull request 的要求以及贡献代码的过程。

贡献核心规则

本节介绍了如何添加到 ESLint 的核心规则。

治理

描述了 ESLint 的治理政策,包括项目内部个人的权利和特权。

报告安全漏洞

要报告 ESLint 中的安全漏洞,请在 GitHub 上创建一个 advisory。

签署 CLA

为了向 ESLint 项目提交代码或文档,您需要以电子方式签署我们的贡献者许可协议 (CLA)。CLA 是常用的 Apache 风格模板,您通过签署 CLA 授予我们使用您的贡献的许可。您只需为任何使用 EasyCLA 的 OpenJS 基金会项目签署一次 CLA。在您打开的第一个 pull request 中,系统会要求您签署 CLA。

更改语言