Working on Issues

Our public issues tracker lists all of the things we plan on doing as well as suggestions from the community. Before starting to work on an issue, be sure you read through the rest of this page.

我们公共的 issues tracker 列出了我们计划做的所有事情以及社区的建议。开始处理某个 issue 之前,请务必通读这一页的其余部分。

Issue Labels

We use labels to indicate the status of issues. The most complete documentation on the labels is found in the Maintainer Guide, but most contributors should find the information on this page sufficient. The most important questions that labels can help you, as a contributor, answer are:

我们使用标签来表示 issue 的状态。标签的最完整文档可以在 Maintainer Guide 找到,对于大多数贡献者来说,本页的信息已经足够了。最为贡献者,标签可以帮助你回答的最重要的问题是:

  1. Is this issue available for me to work on? If you have little or no experience contributing to ESLint, the good first issue label marks appropriate issues. Otherwise, the help wanted label is an invitation to work on the issue. If you have more experience, you can try working on other issues labeled accepted. Conversely, issues not yet ready to work on are labeled triage, evaluating, and/or needs bikeshedding, and issues that cannot currently be worked on because of something else, such as a bug in a dependency, are labeled blocked.
  2. 这个 issue 我能解决吗?如果你 ESLint 贡献很少或没有经验,带有good first issue 标签的 issue 比较适合你。另外,help wanted 标签是要求你来解决此 issue。如果你有更多的经验,你可以尝试解决带有 accepted 标签的 issue。与此相反,尚未准备好的 issue 被标记为 triageevaluating 和/或 needs bikeshedding,而由于其他原因(比如依赖项中的一个 bug)当前无法处理的,被标记为 blocked
  3. What is this issue about? Labels describing the nature of issues include bug, enhancement, feature, question, rule, documentation, core, build, cli, infrastructure, breaking, and chore. These are documented in the Maintainer Guide.
  4. 这个 issue 是关于什么的?标签用来描述 issue 的本质,包括 bugenhancementfeaturequestionruledocumentationcorebuildcliinfrastructurebreakingchore。这些标签在 Maintainer Guide 中有详细介绍。

  5. What is the priority of this issue? Because we have a lot of issues, we prioritize certain issues above others. The following is the list of priorities, from highest to lowest:

  6. 一个 issue 的优先级是什么?因为我们有很多 issue,我们优先考虑某些 issue。以下是优先级列表,从高到低:

    1. Bugs - problems with the project are actively affecting users. We want to get these resolved as quickly as possible.
    2. Bugs - 项目中的问题已经影响到了他人。我们想让这些 issue 尽可能快地得到解决。
    3. Documentation - documentation issues are a type of bug in that they actively affect current users. As such, we want to address documentation issues as quickly as possible.
    4. Documentation - 文档 issue 是一种直接影响当前用的bug。因此,我们想尽可能快地解决文档 issue。
    5. Features - new functionality that will aid users in the future.
    6. Features - 在将来能帮助用户的新功能。
    7. Enhancements - requested improvements for existing functionality.
    8. Enhancements - 要求改进现有功能。
    9. Other - anything else.
    10. Other - 其他。

Some issues have had monetary rewards attached to them. Those are labeled bounty. Bounties are assigned via BountySource.

有些 issue 还附带的金钱奖励。这些 issue 被标记为 bounty。奖金通过 BountySource 分配。

Starting Work

If you’re going to work on an issue, please add a comment to that issue saying so and indicating when you think you will complete it. It will help us to avoid duplication of effort. Some examples of good comments are:

如果你要处理一个 issue,请给该 issue 添加一个评论说明你认为在何时将完成它。它将帮助我们避免重复的工作。一些好的评论的例子如下:

If an issue has already been claimed by someone, please be respectful of that person’s desire to complete the work and don’t work on it unless you verify that they are no longer interested.

如果一个 issue 已被认领,请尊重他想完成这项工作的愿望,除非你确定他们已经不再感兴趣了,否则不要处理它。

If you find you can’t finish the work, then simply add a comment letting people know, for example:


No one will blame you for backing out of an issue if you are unable to complete it. We just want to keep the process moving along as efficiently as possible.

如果你不能完成某个 issue,没有人会因为你的退出而责备你。我们只是想让这个过程尽可能高效地进行下去。