doing docs process labels.md
7.1 kB · 138 lines
Markdown
at main

Labels #

Labels are used to categorize and track issues and pull requests. Each label belongs to a color-coded category that indicates its purpose at a glance.

Color Scheme #

Swatch Category Description
bug Bug Reserved exclusively for bugs
priority Priority Issue priority level
status Status Current workflow status (max: 1 per issue)
type Type Kind of work being done (max: 1 per issue)
area Area Affected component or area of the codebase
discussion Discussion Discussion or exploration type
semver Semver Impact Semantic versioning impact of the change
meta Meta Additional context or contributor info
resolution Resolution How the issue was resolved (max: 1 per issue)

Rules #

  • An issue may only have one Type label (green)
  • An issue may only have one Status label (yellow)
  • An issue may only have one Resolution label (light gray)

Categories #

Bug (b60205) #

The bug label stands alone in its own category. When an issue is labeled bug, it indicates something that was previously working is now broken or behaving incorrectly. Bug issues should also receive a priority label.

Label Description
bug Something isn't working

Priority (d93f0b) #

Priority labels indicate urgency and help with sprint planning. Every issue should eventually receive a priority label during triage. Multiple priority labels on a single issue are discouraged but not enforced.

Label Description
p0 Critical — drop everything
p1 High — address this sprint
p2 Medium — address soon
p3 Low — when time permits
p4 Minimal — nice to have

Status (fbca04) #

Status labels track where an issue is in the workflow. An issue must have at most one status label at any time. Update the status label as work progresses rather than stacking them.

Label Description
triage Needs review and categorization
in progress Actively being worked on
blocked Waiting on an external dependency or decision

Type (6aa654) #

Type labels describe the kind of work an issue represents. An issue must have at most one type label.

Label Description
enhancement New feature or improvement
epic A large feature composed of multiple issues
fix Non-bug fix or correction
chore Maintenance or housekeeping task
optimization Performance or efficiency improvement
release Release preparation and versioning

Area (1d76db) #

Area labels identify which part of the codebase is affected. An issue may have multiple area labels when changes span several components.

Label Description
build Build system and CI/CD pipeline
cli Command-line interface
config Configuration and settings
dependencies Dependency updates and management
documentation Documentation changes
ops Task operations
plugins Plugin system
taskpaper TaskPaper format parsing
template Template rendering
tests Test infrastructure and coverage
time Time parsing and formatting

Discussion (5319e7) #

Discussion labels are used for issues that are exploratory or conversational rather than actionable work items. They may eventually produce actionable issues but exist primarily to gather input.

Label Description
discussion Open-ended discussion topic
question Request for information or clarification
rfc Request for comments on a proposed change
spike Research or exploration task

Semver Impact (f9d0c4) #

Semver labels indicate the semantic versioning impact of the change once resolved. They help with release planning and changelog generation.

Label Description
major change Breaking change requiring a major version bump
minor change Backwards-compatible feature requiring a minor version bump
patch change Backwards-compatible fix requiring a patch version bump

Meta (333333) #

Meta labels provide additional context about an issue. They can be combined freely with other categories.

Label Description
dependabot Automated dependency update from Dependabot
good first issue Good for newcomers
help wanted Extra attention is needed
regression Previously working functionality that is now broken
security Security-related issue or vulnerability

Resolution (cccccc) #

Resolution labels indicate why an issue was closed without completing the requested work. An issue must have at most one resolution label. Issues closed as completed do not need a resolution label.

Label Description
duplicate This issue already exists
invalid This issue is not valid
on hold Postponed indefinitely
wontfix This will not be worked on