forked from DonJayamanne/pythonVSCode
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Issue Management
Brett Cannon edited this page Sep 1, 2021
·
9 revisions
Every issue in the repository should:
- A clear title.
- Have labels explaining why the issue is still open.
- Have labels explaining what the issue applies to (e.g. debugging).
- Have labels explaining what sort of issue something is (e.g. a bug).
... receive the classify label so they can be triaged.
- The
buglabel is added. - The appropriate
arealabel is added. - Issues get assigned to someone and receive the
triagelabel, replacing theclassifylabel. - If more information is needed from the original poster (OP), the
info neededlabel is added, being removed once the OP responds with the requested information. - The
investigatinglabel is applied when the person assigned to triage the issue has started looking into the cause of the issue (this may come after a couple of messages between the OP and the assigned person to clearly understand what needs investigation). - If the issue is found to be legitimate, the appropriate
needslabel replaces theinvestigatinglabel (e.g.needs spike,needs PR).
- If a fix requires investigation, it will have the
needs spikelabel. - Once a solution is decided upon, the bug will have the
needs PRlabel. - Scheduling a fix will be based on how many users are affected, is there a workaround and how arduous is it, difficulty of the fix, etc.
Bugs can be closed if:
- The issue was opened in error by the OP.
- The issue cannot be reproduced.
- The OP did not respond to a request for more information.
- The bug has been fixed in the next release and has been added to the appropriate milestone.
- The
feature-requestlabel is added. - The appropriate
arealabel is added. - A determination is made whether the team wants to accept the suggestion, outright, adding
needs PRorneeds proposalif it is. - If the team isn't ready to necessarily accept a feature request,
needs feedbackis added and a comment detailing what is required for an issue to be re-considered for acceptance is left.
- If
needs proposalis on the feature request then a discussion needs to occur to decide how to implement the request. - Once a solution is agreed upon, the
needs PRlabel is added. - A feature request will be scheduled to implementation based on number of users who will benefit, difficulty of implementing, etc.
- We have chosen not to pursue a feature request based on community feedback.
- A feature has been implemented for the next release and has been added to the appropriate milestone (the issue is expected to also have either the
on-testplanorverification-neededlabel applied as appropriate before we reach endgame week; see release testing for details)