-
-
Notifications
You must be signed in to change notification settings - Fork 52
Issue to review the contributing document and add a triage process proposal #538
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
Merged
Merged
Changes from 5 commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
ea109bc
Issue to review the contributing document and add a triage process pr…
benjagm f5c7d00
Updated to adhere to Sensible Github Labels
benjagm 3a3c07d
Update 'info-required' wording
benjagm c39cacd
Remove vote as type of issue. This will be made through discussions.
benjagm e26e41f
Add clear paths to contributions
benjagm 21f8a29
Remove double space
Relequestual a3499f7
Fix contributing to focus on community repo and add community manager…
benjagm 68f5842
Refactoring of the Community README
benjagm f5f5e1f
Update README.md
benjagm f03f433
Style of links
benjagm a3d1e9e
added emojis to index
benjagm fe7383a
Update README.md
benjagm f874488
Update README.md
benjagm a631d88
Update README.md
benjagm 32214a9
Added contributors
benjagm f4c6267
Changes to clarify slack channel for discussion
benjagm b0b47fe
Moved the triage back to org level
benjagm 57d8216
Apply suggestions from code review
benjagm 7ed8296
Merge branch 'main' into benjagm-contributing-exp
benjagm File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
## Introduction | ||
|
||
This document will outline the process of triaging GitHub issues. **Triage** is the process of reviewing and labeling incoming issues, identifying any which are critical, and escalating the critical ones. | ||
|
||
The core maintainers of each project are responsible for categorizing all incoming issues and delegating any critical or important issue to other maintainers. Currently one maintainer each week is responsible. Besides that part, triage provides an important way to contribute to an open source project. | ||
|
||
Triage helps ensure issues resolve quickly by: | ||
|
||
- Ensuring the issue's intent and purpose is conveyed precisely. This is necessary because it can be difficult for an issue to explain how an end user experiences a problem and what actions they took. | ||
- Giving a contributor the information they need before they commit to resolving an issue. | ||
- Lowering the issue count by preventing duplicate issues. | ||
- Streamlining the development process by preventing duplicate discussions. | ||
|
||
If you don't have the knowledge or time to code, consider helping with triage. The community will thank you for saving them time by spending some of yours. | ||
|
||
## GitHub Labels | ||
|
||
Labels are assigned based on [Sensible Github Labels](https://github.com/Relequestual/sensible-github-labels). | ||
|
||
Type labels help categorize issues based on their scope: | ||
| Label | Description | | ||
| ------------------------ | ------------------------------------------------------------------------- | | ||
| `🐛 Bug` | Indicates that the issue is a bug or a software defect. | | ||
| `✨ Enhancement` | Indicates that the issue suggests an improvement or new feature. | | ||
| `📝 Documentation` | Indicates improvements or additions to documentation. | | ||
| `🎯 Roadmap` | Indicates epics and tasks related to roadmap items. | | ||
| `🏗️ Programs` | Indicates epics and tasks related to Community programs. | | ||
| `👥 Team` | Indicates issues for team collaboration. | | ||
| `🗃️ Adr-required` | Indicates issues requiring Architectural Decision Record | | ||
| `💬 Question` | A query or seeking clarification. Probably doesn't need the attention of everyone, just a few to help bring clarification or explain intent.| | ||
|
||
Priority labels: | ||
| Label | Description | | ||
| ------------------------ | ------------------------------------------------------------------------- | | ||
| `Priority: Critical` | This should be dealt with ASAP. Not fixing this issue would be a serious error.| | ||
| `Priority: High` | After critical issues are fixed, these should be dealt with before any further issues.| | ||
| `Priority: Medium` | This issue may be useful, and needs some attention.| | ||
| `Priority: Low` | This issue can probably be picked up by anyone looking to contribute to the project, as an entry fix.| | ||
|
||
Status labels: | ||
| Label | Description | | ||
| ------------------------ | ------------------------------------------------------------------------- | | ||
| `Status: Available` | No one has claimed responsibility for resolving this issue. Generally this will be applied to bugs and enhancement issues, but may be applied to others.| | ||
| `Status: Accepted` | It's clear what the subject of the issue is about, and what the resolution should be.| | ||
| `Status: Blocked` | There is another issue that needs to be resolved first, or a specific person is required to comment or reply to progress. There may also be some external blocker.| | ||
| `Status: Completed` | Nothing further to be done with this issue. Awaiting to be closed by the requestor out of politeness, or can be closed by a project member.| | ||
| `Status: In Progress` | This issue is being worked on, and has someone assigned.| | ||
| `Status: On Hold` | Similar to blocked, but is assigned to someone. May also be assigned to someone because of their experience, but it's recognised they are unable to process the issue at this time.| | ||
| `Status: Review Needed` | The issue has a PR attached to it which needs to be reviewed. Should receive review by others in the community, and at least one member / comitter. Specifics on when merging PRs is allowed is still up for debate.| | ||
| `Status: Revision Needed`| At least two people have seen issues in the PR that makes them uneasy. Submitter of PR needs to revise the PR related to the issue.| | ||
| `Status: Abandoned` | It's believed that this issue is no longer important to the requestor and no one else has shown an interest in it.| | ||
|
||
Other labels: | ||
| Label | Description | | ||
| ------------------------ | ------------------------------------------------------------------------- | | ||
| `good first issue` | Indicates that the issue is suitable for newcomers to contribute to the project.| | ||
| `duplicate` | Indicates that is duplicated. | | ||
| `info-required` | Indicates that the issue lacks sufficient information to be able to act on it right now and requires additional details from the reporter. The maintainer for the area must remove the tag when more info is provided, or close it if it is too old.| | ||
|
||
## Triage process | ||
|
||
At the end of reading an issue, you should do one of the following: | ||
|
||
1. Make sure to search in previous issue to ensure this is not a duplicated issue. If that is the case, mark it as `duplicate` and close it referencing the original issue. If the issue is clear, ensure it has the correct `type` assigned and the status `status: Available`. Also consider if it is a `good first issue`. | ||
|
||
2. Asses the issue priority to determine what functionality is affected and how broken it is and use the priority labels. | ||
|
||
3. If the submitter or the reviewer believe the resolution of the Issue is likely to result in a significant or noteworthy change it will be labeled as `adr-required`. | ||
|
||
4. Move the issue to the correct repo if required. | ||
|
||
5. If it's not clear what the problem or issue is, add a note for the requestor (or occasionally some other user on the thread), and mark it as `info-required`. If a `info-required` issue persists for longer than 2 weeks or so (past a second followup), it's reasonable to `close` the issue using `Status: Abandoned` and encourage the requester to reopen if they have more details. | ||
|
||
6. If the request is infeasable, or complete,use `status: Completed` follow up directly in the issue with the information, and `close` the issue. | ||
|
||
### References | ||
|
||
This process has been inspired by some great processes defined by Open Source projects like: | ||
- [Knative triage process](https://github.com/knative/serving/blob/main/support/TRIAGE.md). | ||
- [Grafana triage process](https://github.com/grafana/faro-web-sdk/blob/main/ISSUE_TRIAGE.md). | ||
- [Wordpress triage process](https://github.com/wordpress-mobile/WordPress-iOS/blob/trunk/docs/issue-triage.md). | ||
- [Sensible Github Labels](https://github.com/Relequestual/sensible-github-labels). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.