Skip to content
GroundworkGroundwork
Esc
↑↓navigate↵open⌘Jpreview
On this page

Labels

The label sets in Title Case, each with a description and a colour distinct within any repository.

Labels are Title Case. Families use Group: Value. Every label has a one-line description in the same voice: types say what the change does, areas say “Related to …”, statuses say what they wait on. Every colour in a repository is distinct, checked in OKLab, and families share a hue band. Brand labels (operating systems, languages, services) use the brand’s colour, and other labels move to keep clear of them.

The label job renames a label listed under Renames rather than deleting it, so issues keep their labels. It never removes a label it doesn’t know without asking.

Every repository

Type

LabelDescriptionRenames
BugSomething isn't working as it should
Bug FixFixes a bugbugfix
FeatureAdds a new feature or optionnew-feature
EnhancementImproves an existing feature
RefactorRestructures code without changing behaviour
PerformanceImproves performance without adding features
Breaking ChangeChanges behaviour existing users rely onbreaking-change
SecurityA security issue that needs fixing as soon as possible
DocumentationRelated to the docs site, README or other documentation
TestsRelated to tests
CIRelated to GitHub workflows and continuous integration
MaintenanceGeneral upkeep and housekeeping
DependenciesUpgrades or downgrades dependencies
AgentsChanges to agent instructions, skills and related configuration
AccessibilityAffects people using assistive technology, keyboards or high contrast

Status

LabelDescriptionRenames
PlannedAccepted and planned to be implemented
ReadyUnblocked and ready to start
In ProgressSomeone is working on thisin-progress
Needs DecisionWaiting on a decision before work can start
Needs ResearchNeeds looking into before it can be plannedneeds-research, Needs Investigation, investigation
BlockedBlocked by something else and can't continue
On HoldPaused until something else is done or decided
FutureWanted, but for a later round

Resolution

LabelDescriptionRenames
DuplicateThis issue or pull request already exists
InvalidNot valid or not applicable to this project
Won't FixThis will not be worked onwontfix

By kind

Community extras

LabelDescriptionRenames
Needs More InformationMore information is needed before this can continueincomplete
Waiting for ReplyWaiting for the author to replywaiting-for-response
Unable to ReproduceCan't be reproduced, may be down to configuration or the systemunable-to-reproduce
Upstream IssueCaused by a dependency or the operating system, not this project
Feature RequestAn idea to weigh, or a discussion where Discussions are on
Good First IssueSuitable for first-time contributorsbeginner-friendly
Help WantedExtra hands or expertise are needed to resolve thishelp-wanted
StaleNo activity for some time, marked by the stale bot
No StaleThe stale bot won't mark or close thisno-stale
Version: MajorNeeds a major version bumpmajor
Version: MinorNeeds a minor version bumpminor

Shared extras

LabelDescriptionRenames
Upstream IssueCaused by a dependency or the operating system, not this project
Needs More InformationMore information is needed before this can continueincomplete

Opt-in

A repository lists these in its own file.

Renovate

One per ecosystem the repository uses, for Renovate’s pull requests.

LabelDescriptionRenames
GitHub ActionsUpdates GitHub Actionsgithub_actions
GoUpdates Go code or modules
JavaScriptUpdates JavaScript or TypeScript code or packages
PythonUpdates Python code or packages

Priority

LabelDescriptionRenames
Priority: CriticalNeeds fixing as soon as possiblepriority-critical
Priority: HighNext to be dealt with after critical issuespriority-high
Priority: MediumUseful and needs some attentionpriority-medium
Priority: LowNice to have, maybe somedaypriority-low

Operating system

LabelDescriptionRenames
OS: LinuxSpecific to Linux
OS: WindowsSpecific to Windows
OS: macOSSpecific to macOS
OS: AndroidSpecific to Android
OS: iOSSpecific to iOS and iPadOS

Test kinds

LabelDescriptionRenames
Tests: UnitRelated to unit tests
Tests: E2ERelated to end-to-end tests

Areas

Each repository can add labels for its own parts, described as “Related to …”. They’re on Repositories.

Last updated on