Skip to content

Commit fef04b5

Browse files
nzakasamareshsm
andauthored
docs: Update working on issues info (#19902)
* docs: Update working on issues info fixes #19900 * Update CONTRIBUTING.md * Update docs/src/contribute/work-on-issue.md Co-authored-by: Amaresh S M <amareshsm13@gmail.com> --------- Co-authored-by: Amaresh S M <amareshsm13@gmail.com>
1 parent 6769b5f commit fef04b5

File tree

2 files changed

+30
-9
lines changed

2 files changed

+30
-9
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,10 @@ To report a security vulnerability in ESLint, please use our [create an advisory
1919

2020
## Contributing Code
2121

22-
In order to submit code or documentation to an ESLint project, you’ll be asked to sign our CLA when you send your first pull request. (Read more about the OpenJS Foundation CLA process at <https://cla.openjsf.org/>.) Also, please read over the [Pull Request Guidelines](https://eslint.org/docs/latest/contribute/pull-requests).
22+
In order to submit code or documentation to an ESLint project, you’ll be asked to sign our CLA when you send your first pull request. (Read more about the OpenJS Foundation CLA process at <https://cla.openjsf.org/>.) Also, please read:
23+
24+
- [Working on issues](https://eslint.org/docs/latest/contribute/work-on-issue)
25+
- [Pull Request Guidelines](https://eslint.org/docs/latest/contribute/pull-requests)
2326

2427
## Full Documentation
2528

docs/src/contribute/work-on-issue.md

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,29 +13,47 @@ Our public [issues tracker](https://github.com/eslint/eslint/issues) lists all o
1313

1414
We use labels to indicate the status of issues. The most complete documentation on the labels is found in the [Maintain ESLint documentation](../maintain/manage-issues#when-an-issue-or-pull-request-is-opened), 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:
1515

16-
1. Is this issue available for me to work on? If you have little or no experience contributing to ESLint, the [`good first issue`](https://github.com/eslint/eslint/labels/good%20first%20issue) label marks appropriate issues. Otherwise, the [`help wanted`](https://github.com/eslint/eslint/labels/help%20wanted) label is an invitation to work on the issue. If you have more experience, you can try working on other issues labeled [`accepted`](https://github.com/eslint/eslint/labels/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`.
17-
1. 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 [Maintain ESLint](../maintain/manage-issues#types-of-issues-and-pull-requests).
18-
1. 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:
16+
1. **Is this issue ready for a pull request?** Issues that are ready for pull requests have the [`accepted`](https://github.com/eslint/eslint/labels/accepted) label, which indicates that the team has agreed to accept a pull request. Please do not send pull requests for issues that have not been marked as accepted.
17+
2. **Is this issue right for a beginner?** If you have little or no experience contributing to ESLint, the [`good first issue`](https://github.com/eslint/eslint/labels/good%20first%20issue) label marks appropriate issues. Otherwise, the [`help wanted`](https://github.com/eslint/eslint/labels/help%20wanted) label is an invitation to work on the issue. If you have more experience, you can try working on other issues labeled [`accepted`](https://github.com/eslint/eslint/labels/accepted).
18+
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 [Maintain ESLint](../maintain/manage-issues#types-of-issues-and-pull-requests).
19+
4. **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:
1920

2021
1. **Bugs** - problems with the project are actively affecting users. We want to get these resolved as quickly as possible.
2122
1. **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.
2223
1. **Features** - new functionality that will aid users in the future.
2324
1. **Enhancements** - requested improvements for existing functionality.
2425
1. **Other** - anything else.
2526

26-
Some issues have had monetary rewards attached to them. Those are labeled `bounty`. Bounties are assigned via [BountySource](https://www.bountysource.com/teams/eslint/issues).
27-
2827
## Starting Work
2928

30-
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:
29+
::: important
30+
Before starting to work on an existing issue, please check if the issue has been assigned to anyone. If it has, then that person is already responsible for submitting a pull request and you should choose a different issue to work on.
31+
:::
32+
33+
### Claiming an issue
34+
35+
If you're going to work on an issue, please _claim_ the issue by adding a comment saying you're working on it and indicating when you think you will complete it. This helps us to avoid duplication of effort. Some examples of good claim comments are:
3136

3237
- "I'll take a look at this over the weekend."
3338
- "I'm going to do this, give me two weeks."
3439
- "Working on this" (as in, I'm working on it right now)
3540

36-
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.
41+
The team will validate your claim by assigning the issue to you.
42+
43+
### Offering help on a claimed issue
44+
45+
If an issue has an assignee or 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 or would welcome the help. If there hasn't been activity on the issue after two weeks, you can express your interest in helping with the issue. For example:
46+
47+
- "Are you still working on this? If not, I'd love to work on it."
48+
- "Do you need any help on this? I'm interested."
49+
50+
It is up to the assignee to decide if they're going to continue working on the issue or if they'd like your help.
51+
52+
If there is no response after a week, please contact a team member for help.
53+
54+
### Unclaiming an issue
3755

38-
If you find you can't finish the work, then simply add a comment letting people know, for example:
56+
If you claimed an issue and find you can't finish the work, then add a comment letting people know, for example:
3957

4058
- "Sorry, it looks like I don't have time to do this."
4159
- "I thought I knew enough to fix this, but it turns out I don't."

0 commit comments

Comments
 (0)