docs: triage bug vs enhancement and apply type labels consistently#4768
Open
andygrove wants to merge 1 commit into
Open
docs: triage bug vs enhancement and apply type labels consistently#4768andygrove wants to merge 1 commit into
andygrove wants to merge 1 commit into
Conversation
Update the bug triage guide and bug-triage skill so triage classifies each requires-triage issue as a bug or an enhancement and applies the matching type label. requires-triage is auto-applied to all new issues, not just bug reports, so the first decision is always bug vs enhancement. Bugs get the bug label plus a priority label; enhancements get the enhancement label and no priority. An issue must never carry both bug and enhancement.
andygrove
requested review from
comphead,
kazuyukitanimura,
mbutrovich and
parthchandra
comphead
reviewed
Jun 30, 2026
| - `bug`: something is broken. Wrong results, crashes, panics, regressions, | ||
| test/CI failures, or any behavior that differs from what Comet should do. | ||
| - `enhancement`: a request for new functionality or improvement that is not | ||
| yet expected to work. New expression/operator support, a new config, a |
Contributor
There was a problem hiding this comment.
maybe we need to define a rule to break a tie, if bot cannot decide ultimately if the issue is a bug or feature?
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Which issue does this PR close?
N/A. This is a small documentation and tooling change to the triage process.
Rationale for this change
The
requires-triagelabel is auto-applied to every new issue, not just bug reports. The bug triage guide and thebug-triageskill, however, only described assigning priority and area labels, implicitly treating every triaged issue as a bug. As a result thebuglabel was applied inconsistently and was sometimes present on issues that are really feature requests. This makes the first triage decision explicit: classify each issue as a bug or an enhancement, and apply the matching type label.What changes are included in this PR?
docs/source/contributor-guide/bug_triage.md: add a "Type Labels" section describing thebugandenhancementlabels and the rule that an issue must never carry both, that the type is decided from issue content rather than title wording, and that only bugs receive a priority label. The "For New Issues" steps now start with the bug-vs-enhancement decision..claude/skills/bug-triage/SKILL.md: the triage pass now classifies each issue as a bug or an enhancement first, appliesbug(plus a priority) orenhancement(no priority), always removes the opposite type label so the two are mutually exclusive, and reports bugs and enhancements separately in the summary issue.How are these changes tested?
Documentation and skill-instruction changes only; there is no code to test. The
ghlabel commands in the skill use labels that already exist in the repository (bug,enhancement, thepriority:*andarea:*labels).