Skip to content

Commit a894b35

Browse files
Try to improve triage docs (WordPress#16234)
* try improve trage docs * spelling fix * Update CONTRIBUTING.md Co-Authored-By: Chris Van Patten <[email protected]> * Update docs/contributors/repository-management.md Co-Authored-By: Chris Van Patten <[email protected]> * Update docs/contributors/repository-management.md Co-Authored-By: Chris Van Patten <[email protected]> * Update docs/contributors/repository-management.md Co-Authored-By: Chris Van Patten <[email protected]>
1 parent 13cab46 commit a894b35

File tree

2 files changed

+18
-4
lines changed

2 files changed

+18
-4
lines changed

CONTRIBUTING.md

+6
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,12 @@ Please see the [Developer Contributions section](/docs/contributors/develop.md)
1818

1919
If you'd like to contribute to the design or front-end, feel free to contribute to tickets labelled [Needs Design](https://github.com/WordPress/gutenberg/issues?q=is%3Aissue+is%3Aopen+label%3A%22Needs+Design%22) or [Needs Design Feedback](https://github.com/WordPress/gutenberg/issues?q=is%3Aissue+is%3Aopen+label%3A"Needs+Design+Feedback%22). We could use your thoughtful replies, mockups, animatics, sketches, doodles. Proposed changes are best done as minimal and specific iterations on the work that precedes it so we can compare. The [WordPress Design team](http://make.wordpress.org/design/) uses [Figma](https://www.figma.com/) to collaborate and share work. If you'd like to contribute, join the [#design channel](http://wordpress.slack.com/messages/design/) in [Slack](https://make.wordpress.org/chat/) and ask the team to set you up with a free Figma account. This will give you access to a helpful [library of components](https://www.figma.com/file/ZtN5xslEVYgzU7Dd5CxgGZwq/WordPress-Components?node-id=0%3A1) used in WordPress.
2020

21+
## Triage Contributions
22+
23+
*Triage* is the practice of reviewing existing issues to make sure they’re relevant, actionable, and have all the information needed to reproduce and/or solve the issue. Triaging is a very important contribution because it allows the community to focus on and prioritise issues, feature proposals, discussions, and so on.
24+
25+
If you want to learn more about triage, and why it it important, please see the [repository management section](docs/contributors/repository-management.md#triaging-issues) of the Contributor Handbook.
26+
2127
## Contribute to the Documentation
2228

2329
Please see the [Documentation section](/docs/contributors/document.md) of the Contributor Handbook.

docs/contributors/repository-management.md

+12-4
Original file line numberDiff line numberDiff line change
@@ -60,12 +60,16 @@ To keep the issue list healthy, it needs to be triaged regularly. *Triage* is th
6060

6161
Anyone can help triage, although you’ll need contributor permission on the Gutenberg repository to modify an issue’s labels or edit its title.
6262

63-
Here are a couple places you can start:
63+
To start simply choose from one of these filtered lists of issues:
6464

65-
- [All Gutenberg issues without an assigned label](https://github.com/wordpress/gutenberg/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-asc+no%3Alabel).
66-
- [The least recently updated Gutenberg issues](https://github.com/WordPress/gutenberg/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-asc).
65+
- [All Gutenberg issues without an assigned label](https://github.com/wordpress/gutenberg/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-asc+no%3Alabel). Triaging by simply adding labels helps people focused on certain aspects of Gutenberg find relevant issues easier and start working on them.
66+
- [The least recently updated Gutenberg issues](https://github.com/WordPress/gutenberg/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-asc). Triaging issues that are getting old and possibly out of date keeps important work from being overlooked.
67+
- [All Gutenberg issues with no comments](https://github.com/WordPress/gutenberg/issues?q=is%3Aopen+is%3Aissue+sort%3Acomments-asc) Triaging this list helps make sure all issues are acknowledged, and can help identify issues that may need more information or discussion before they are actionable.
68+
- [The least commented on issues](https://github.com/WordPress/gutenberg/issues?q=is%3Aopen+is%3Aissue+sort%3Acomments-asc) Triaging this list helps the community figure out things like traction for certain proposals.
6769

68-
When reviewing issues, here are some steps you can perform:
70+
You can also create your own custom set of filters on GitHub. If you have a filter you think might be useful for the community, feel free to submit a PR to add it to this list.
71+
72+
When triaging, either one of the lists above or issues in general, here are some steps you can perform:
6973

7074
- First search for duplicates. If the issue is duplicate, close it by commenting with “Duplicate of #<original-id>” and add any relevant new details to the existing issue.
7175
- If the issue is missing labels, add some to better categorize it (requires proper permissions).
@@ -78,6 +82,10 @@ When reviewing issues, here are some steps you can perform:
7882
- Check that the bug report is valid by debugging it to see if you can track down the technical specifics.
7983
- Check if the issue is missing some detail and see if you can fill in those details. For instance, if a bug report is missing visual detail, it’s helpful to reproduce the issue locally and upload a screenshot or GIF.
8084

85+
For triaging there are some labels which are very useful:
86+
- `Needs Technical Feedback` - you can apply them when you see new features or API changes proposed
87+
- `Needs More Info` - when it’s not clear what the issue is or it would help to provide additional details
88+
- `Needs Testing` - it’s useful for old bugs where it seems like they are no longer relevant
8189

8290
## Pull Requests
8391

0 commit comments

Comments
 (0)