Repository navigation
Document structured label usage - #2010
Open
yoshuawuyts wants to merge 2 commits into
Open
yoshuawuyts wants to merge 2 commits into
yoshuawuyts wants to merge 2 commits into
Conversation
yoshuawuyts
requested review from
andreiltd,
danbugs,
dblnz,
devigned,
jprendes,
jsturtevant,
ludfjig,
simongdavies,
squillace and
syntactically
as code owners
November 2, 2026 10:57
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The documentation directs contributors to labels that current checks and automation do not use and omits guidance on active issue-triage labels.
3 open issues
What changed in this PR
Documents HIP 0005’s proposed structured labels for Hyperlight, with transition guidance for automation that still requires legacy names.
Changes:
- Describes seven label prefixes and 40 proposed labels for issues and PRs.
- Covers review readiness, issue triage, CI failure grouping, release blocking, and snapshot golden regeneration.
- Keeps workflow updates and live-label migration outside this documentation-only scope.
| File | Description |
|---|---|
docs/github-labels.md |
Defines proposed labels, their usage, and legacy automation requirements during migration. |
Review effort: Balanced
| - **kind/dependencies** - For PRs that update dependencies or related components. | ||
| - **kind/enhancement** - For PRs that introduce new features or improve existing functionality. This label also applies to improvements in documentation, testing, and similar areas. Any changes must be backward-compatible. | ||
| - **kind/refactor** - For PRs that restructure or remove code without adding new functionality. This label also applies to changes that affect user-facing APIs. | ||
| We use GitHub labels to categorize PRs. Before a PR can be merged, it must be assigned one of the following **C-** labels: |
| - the PR is converted to a draft, | ||
| - the PR has two or more approvals, or | ||
| - the PR has two or more change requests. | ||
| * **Add** `S-needs-review` when you open a PR that is ready for review, or when a PR is ready for re-review (for example, once you have addressed requested changes and re-requested review). |
| * **enhancement**: Suggests a new feature, improvement, or idea. | ||
|
|
||
| To track the lifecycle of issues, we also use GitHub labels: | ||
| To track the status of issues, we also use GitHub labels: |
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: Yosh <github@yosh.is>
Signed-off-by: Yosh <github@yosh.is> Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
yoshuawuyts
force-pushed
the
yoshuawuyts-structured-label-usage-guide
branch
from
November 2, 2026 13:11
6363eff to
38881a1
Compare
This branch has not been deployed
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
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.
Documentation follow-up to #1978, based on
labels-hip.docs/github-labels.md.Scope is documentation only. Workflow updates and live-label migration require a coordinated rollout.
Validation: exact agreement with the HIP's label tables, local links, table formatting, and
git diff --check.