-
Notifications
You must be signed in to change notification settings - Fork 164
Triage
New issues are filed daily, we need to quickly respond to them and identify the relative timeline for them. This is critical for us to understand bugs, as well as maintaining a strong community.
This document covers how to handle new issues through our issue triage process. It covers issues filed both within GitHub and external issues.
Intended audience: Developers
Initial triage will be handled on a rotating schedule aligned to the sprints. During that time, the assigned triage PiC will follow the below process Issues that do not have a Roadmap
value in the GitHub Project require triage.
- Is the request valid/should it be part of CCCL?
- If not, close as
Will not complete
and comment to the filer the reasoning (we want to be welcoming and encourage them to file new issues in the future) - If an issue is a duplicate close as
Will not complete
and link the duplicate in the comments - If they did not use one of our issue templates but they should have, close as
will not complete
and ask them to refile using our template
- If not, close as
- Ensure the issue type is correct, i.e. is the issue really a bug or is it a feature request?
- If it's a [Question] type issue, convert it to a discussion and answer the question or @ team members as needed
- Review the content of the issue, has the filer provided all of the needed information for that issue type? If not, ask for clarification
- If it's a [Bug] is there enough info (repro, logs, env)?
- If it's a [FEA] is it something we want to add?
- If no, close as
Will not complete
with comments
- If no, close as
- If it's a [Doc] request did the filer look in the correct spot?
- Add any relevant project fields
- Consider adding
good first issue
orhelp wanted
labels to the issue if applicable - Decide the
Roadmap
value the issue should go into- This is somewhat subjective and will be reviewed as a team during release planning
- A good heuristic is
-
Really important? -->
Next Release
- Would be a significant gain? -->
Priority Backlog
- Would be nice? -->
Backlog
-
Really important? -->
- Set the
Roadmap
in the project to the decided release, this removes it from the triage view in the projects and completes the triage
Developers should be assigned to issues they are responsible for delivering. If this issue triaged is going into the current release, Try to limit overcommitting developers. A general rule is to limit active development to 5 or fewer issues.
CCCL will sometimes receive issues from outside of GitHub. The triage process is largely the same but with a slight modification:
- After making sure the issue is valid and has enough information, make a corresponding issue in the CCCL repo
- You must sanitize any and all CI/PII
- In the initial issue, link the newly created GitHub issue
This section is currently empty.