Skip to content

Document the pull request labels release notes are generated from - #3

Merged
oneleggedswede merged 1 commit into
mainfrom
docs/contributing-labels
Sep 6, 2026
Merged

Document the pull request labels release notes are generated from#3
oneleggedswede merged 1 commit into
mainfrom
docs/contributing-labels

Conversation

@oneleggedswede

Copy link
Copy Markdown
Contributor

.github/release.yml sorts merged pull requests into release note categories by label, but the contributing guide said nothing about labels, so a pull request opened by following it arrives unlabelled and is filed under "Other Changes".

Adds a Labels section between Guidelines and Setup, and points step 4 of Process at it.

  • A table of the seven labels a contributor picks from, each with the case it covers.
  • A note that a pull request is listed once, under the first category it matches, so breaking plus enhancement appears under Breaking Changes.
  • The calls that are less obvious: a test or CI fix is maintenance rather than bug, an incorrect doc is documentation rather than bug, a refactor stays maintenance even when it edits resources/views, and breaking applies before 1.0.

duplicate is left out. It is in the exclude list, but it is a triage label a maintainer applies when closing something rather than a call a contributor makes on their own pull request.

The four labels this documents that the repository was missing — breaking, dependencies, maintenance, skip-changelog — now exist, so every label named here is selectable.

Documentation only. No change to src/ or resources/.

@oneleggedswede oneleggedswede added the documentation Improvements or additions to documentation label Sep 6, 2026
@oneleggedswede
oneleggedswede merged commit de3a5d9 into main Sep 6, 2026
13 checks passed
@oneleggedswede
oneleggedswede deleted the docs/contributing-labels branch September 6, 2026 17:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant