-
Notifications
You must be signed in to change notification settings - Fork 23.1k
Issue assignment process clarification #42926
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
|
Preview URLs (1 page) External URLs (2)URL:
(comment last updated: 2026-01-30 00:34:53) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@hamishwillee looks good, man; a couple of suggestions, but nothing major.
Also, while you're here, consider:
- Fixing the grammar issue in the first numbered bullet — "If you're looking to contribute, search for issues with" should be "If you're looking to contribute, search for issues with a"
- Adding a warning about not submitting AI slop fixes, as they waste our time as we will probably close them? Hrm, maybe this one requires more discussion.
caugner
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM from my point of view, I'll let others approve.
Co-authored-by: Chris Mills <chrisdavidmills@gmail.com> Co-authored-by: Claas Augner <495429+caugner@users.noreply.github.com>
|
Thanks all for the review - I have accepted all suggestions and fixed the typo. Chris, yes, would be great to add a comment on AI slop as a separate PR. |
dipikabh
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for taking this on, Hamish! 🙌
I have a few rewording suggestions and a broader suggestion to adjust the step list to accommodate the current set of changes.
chrisdavidmills
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good from my end.
| > An issue with the `needs triage` label indicates that the MDN Web Docs core team has not reviewed the issue yet, and you shouldn't begin work on it. | ||
|
|
||
| 2. **Assign the issue to yourself:** After finding an issue you'd like to work on, make sure that the issue is not assigned to anybody else. Add a comment saying you would like to work on the issue, and if you are able to, [assign the issue to yourself](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/assigning-issues-and-pull-requests-to-other-github-users#assigning-an-individual-issue-or-pull-request). | ||
| 2. **Check that no one is already working on the issue:** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@dipikabh Thanks. I took some of your suggestions directly. But to properly fix the ordering and merging I had to start from scratch (rather than accepting your suggestions), so can you please have another look.
I also formatted the bold parts of each point on their own line, which makes the steps much more readable.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The formatting is looking great, agree, it's more readable and scanable now.
dipikabh
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work! Approving.
I'll check in on Monday to see how it shapes up.
|
|
||
| Remember that if you take on an issue, the expectation is for the work to be completed in a timely manner. If you're not able to make any progress for a week after being assigned or can no longer complete the required task, leave a comment and unassign yourself from the issue. | ||
| Remember that if you take on an issue, the expectation is for the work to be completed in a timely manner. | ||
| If you are unable to progress work on a claimed issue, please add a comment to let us know. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice! I like how you've worked "claimed" into the wording here. Also good point to remove "unassign" 👍
I don't think we use "us" for the core team...we could maybe say "add a comment so maintainers are aware and the issue can be picked up by another contributor."
| 1. **Find an issue:** If you're looking to contribute, search for issues with [`good first issue`, `help wanted`](#set_other_labels) or [`p3`](#set_a_priority_label) label. Most repositories have issues with these labels. You are welcome to browse and pick an issue that is suitable for your skill set. Another useful place to look for issues to work on is the [MDN Contributors Task Board](https://github.com/orgs/mdn/projects/25). This project view lists open issues from multiple repositories. You can filter the list based on the topics (`Labels` column) you're interested in. See the description of some of the [labels](#set_other_labels) that get applied during the issue triage process. | ||
| 1. **Find an issue:** | ||
|
|
||
| If you're looking to contribute, search for issues with a [`good first issue`, `help wanted`](#set_other_labels) or [`p3`](#set_a_priority_label) label. Most repositories have issues with these labels. You are welcome to browse and pick an issue that is suitable for your skill set. Another useful place to look for issues to work on is the [MDN Contributors Task Board](https://github.com/orgs/mdn/projects/25). This project view lists open issues from multiple repositories. You can filter the list based on the topics (`Labels` column) you're interested in. See the description of some of the [labels](#set_other_labels) that get applied during the issue triage process. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
accepting PRlabel will be added via https://github.com/mdn/content/pull/41035/changes L232- Realistically, we don't use priority labels while triaging but I'll let those changes trickle in via that PR.
| If you're looking to contribute, search for issues with a [`good first issue`, `help wanted`](#set_other_labels) or [`p3`](#set_a_priority_label) label. Most repositories have issues with these labels. You are welcome to browse and pick an issue that is suitable for your skill set. Another useful place to look for issues to work on is the [MDN Contributors Task Board](https://github.com/orgs/mdn/projects/25). This project view lists open issues from multiple repositories. You can filter the list based on the topics (`Labels` column) you're interested in. See the description of some of the [labels](#set_other_labels) that get applied during the issue triage process. | |
| If you're looking to contribute, search for issues with a [`good first issue`, `help wanted`](#set_other_labels) or [`p3`](#set_a_priority_label) label. Most repositories have issues with these labels. You are welcome to browse and pick an issue that is suitable for your skill set. Another useful place to look for issues to work on is the [MDN Contributor Board](https://github.com/orgs/mdn/projects/25). This project view lists open issues from multiple repositories. You can filter the list based on the topics (`Labels` column) you're interested in. See the description of some of the [labels](#set_other_labels) that get applied during the issue triage process. |
| 2. **Assign the issue to yourself:** After finding an issue you'd like to work on, make sure that the issue is not assigned to anybody else. Add a comment saying you would like to work on the issue, and if you are able to, [assign the issue to yourself](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/assigning-issues-and-pull-requests-to-other-github-users#assigning-an-individual-issue-or-pull-request). | ||
| 2. **Check that no one is already working on the issue:** | ||
|
|
||
| Before starting work on an issue, first check that no one is assigned to the issue (the _Assignees_ field is "Unassigned"). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Before starting work on an issue, first check that no one is assigned to the issue (the _Assignees_ field is "Unassigned"). | |
| Before starting work on an issue, first check that no one is assigned to the issue (the _Assignees_ field should be "Unassigned"). |
|
|
||
| Before starting work on an issue, first check that no one is assigned to the issue (the _Assignees_ field is "Unassigned"). | ||
|
|
||
| Then check that there are no linked [Pull Requests](/en-US/docs/MDN/Community/Pull_requests), as these may indicate that another user has claimed the issue and started working on it. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Then check that there are no linked [Pull Requests](/en-US/docs/MDN/Community/Pull_requests), as these may indicate that another user has claimed the issue and started working on it. | |
| Then check that there are no linked [Pull Requests](/en-US/docs/MDN/Community/Pull_requests), as these may indicate that another contributor has claimed the issue and started working on it. |
|
|
||
| Most issues need some investigation before work can start. | ||
| - Scope out the work that needs to be done. | ||
| If the issue is not well-described, and/or you are not sure what is needed, feel free to @mention the poster and ask for more information. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| If the issue is not well-described, and/or you are not sure what is needed, feel free to @mention the poster and ask for more information. | |
| If the issue is not well-described, and/or you are not sure what is needed, feel free to mention the person who opened the issue (using @username) and ask for more clarifying information. |
| If you have the necessary permissions, you should also _explicitly_ [assign the issue to yourself](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/assigning-issues-and-pull-requests-to-other-github-users#assigning-an-individual-issue-or-pull-request). | ||
|
|
||
| > [!NOTE] | ||
| > Adding the `Fixes #<issue_number>` or `Related to #<issue_number>` text is what creates a cross-reference between the issue and the PR, and implicitly claims the issue for the PR's author. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
since we've been addressing the contributor, suggesting a change of voice here:
| > Adding the `Fixes #<issue_number>` or `Related to #<issue_number>` text is what creates a cross-reference between the issue and the PR, and implicitly claims the issue for the PR's author. | |
| > Adding the `Fixes #<issue_number>` or `Related to #<issue_number>` text is what creates a cross-reference between the issue and the PR, and implicitly marks the issue as claimed by you. |
|
|
||
| > [!NOTE] | ||
| > Adding the `Fixes #<issue_number>` or `Related to #<issue_number>` text is what creates a cross-reference between the issue and the PR, and implicitly claims the issue for the PR's author. | ||
| > If the work is going to take some time, you might want to create a draft PR to claim the issue before all work is complete. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure if we should mention draft PRs. Folks who know about the option will likely use it judiciously. I'm slightly concerned that documenting it here could encourage folks to "claim" issues early/quickly.
If we do keep it though, we could link to https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request#converting-a-pull-request-to-a-draft
| 5. **Close the issue:** | ||
|
|
||
| 5. After your pull request has been reviewed and merged, you can mark the linked issue as closed. If you opened the pull request with `Fixes #<issue>` verbiage, the issue will be closed automatically when the pull request is merged. | ||
| If you opened the pull request with `Fixes #<issue>` in the description, the issue should automatically be closed when the PR is merged! Otherwise you can manually close the issue. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- I actually prefer the previous phrasing with "will be"
- Contributors might not have permissions to close an issue opened by someone else if they don't have triage permissions.
| If you opened the pull request with `Fixes #<issue>` in the description, the issue should automatically be closed when the PR is merged! Otherwise you can manually close the issue. | |
| If you opened the pull request with `Fixes #<issue>` in the description, the issue will be closed automatically when the PR is merged. Otherwise, you can add a comment to the issue linking to one or more pull requests that fix it, and a maintainer will close the issue as completed. |
| > An issue with the `needs triage` label indicates that the MDN Web Docs core team has not reviewed the issue yet, and you shouldn't begin work on it. | ||
|
|
||
| 2. **Assign the issue to yourself:** After finding an issue you'd like to work on, make sure that the issue is not assigned to anybody else. Add a comment saying you would like to work on the issue, and if you are able to, [assign the issue to yourself](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/assigning-issues-and-pull-requests-to-other-github-users#assigning-an-individual-issue-or-pull-request). | ||
| 2. **Check that no one is already working on the issue:** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The formatting is looking great, agree, it's more readable and scanable now.
| > After opening the pull request, if you find you no longer have the time to make changes or incorporate review feedback, let the team know as soon as possible in a comment in the pull request. This will help the team assign another interested contributor to complete the work on the pull request and close the linked issue. | ||
|
|
||
| After opening the pull request, if you find you no longer have the time to make changes or incorporate review feedback, let the team know as soon as possible in a comment in the pull request. This will help the team assign another interested contributor to complete the work on the pull request and close the linked issue. | ||
| 5. **Close the issue:** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should probably be "Mark the issue as completed"
The Guidelines for working on an issue suggest that users self assign if they can, and otherwise add a comment asking to be assigned.
In theory this is good - user asks to be assigned, and a core user then assigns them. Historically though this often doesn't work - you get people asking to be assigned to multiple issues, then getting assigned and doing no work. The issues then rot.
The current and well established process is that authors start work and create the cross link
Fixes #<issue no.>in the PR to implicitly assign the issue.This updates the process to reflect how assignment is actually handled on MDN.