One of the great things about open source projects is that anyone can contribute in any number of meaningful ways. ESLint couldn’t exist without the help of the many contributors it’s had since the project began, and we want you to feel like you can contribute and make a difference as well.

开源项目最伟大的地方之一在于任何人都能够以有意义的方式作出贡献。ESLint 的存在也离不开众多贡献者自始至终的帮助,我们想要你觉得你可以做出贡献和发挥作用。

This guide is intended for anyone who wants to contribute to an ESLint project. Please read it carefully as it answers a lot of the questions many newcomers have when first working with our projects.

本指南适用于任何想要给 ESLint 项目做出贡献的人。请仔细阅读,因为它回答了许多新人在第一次参与我们项目时遇到的问题。

Read the Code of Conduct

ESLint welcomes contributions from everyone and adheres to the JS Foundation Code of Conduct. We kindly request that you read over our code of conduct before contributing.

ESLint 欢迎所有人参与贡献,遵守 JS 基金会行为准则。在你参与贡献之前请先阅读我们的行为准则。

Signing the CLA

In order to submit code or documentation to an ESLint project, you will need to electronically sign our Contributor License Agreement. The CLA is you giving us permission to use your contribution.

为了给 ESLint 项目提交代码或文档,你需要签署我们的贡献者许可协议。 这份 CLA 表示你授权我们可以使用你的贡献。

Bug Reporting

Think you found a problem? We’d love to hear about it. This section explains how to submit a bug, the type of information we need to properly verify it, and the overall process.


Proposing a New Rule

We get a lot of proposals for new rules in ESLint. This section explains how we determine which rules are accepted and what information you should provide to help us evaluate your proposal.

我们收到了许多新的 ESLint 规则的建议。本节解释了我们如何决定哪些规则是可以被采纳的,以及你应该提供什么信息来给帮助我们评估你的建议。

Proposing a Rule Change

Want to make a change to an existing rule? This section explains the process and how we evaluate such proposals.


Requesting a Change

If you’d like to request a change other than a bug fix or new rule, this section explains that process.

如果你想要请求的变更不是是 bug 修复或新的规则,这部分解释了这一过程。

Reporting a security vulnerability

To report a security vulnerability in ESLint, please use our HackerOne program.

要报告一个 ESLint 中的安全漏洞,请使用 HackerOne program

Working on Issues

Have some extra time and want to contribute? This section talks about the process of working on issues.


Submitting a Pull Request

We’re always looking for contributions from the community. This section explains the requirements for pull requests and the process of contributing code.

我们一直在寻求来自社区的贡献。本节解释了合并请求(pull request)的要求以及贡献代码的过程。