Skip to content

Commit 6a4539d

Browse files
committed
Add back kind/refactor and kind/dependencies, and question, help-wanted, good-first-issue
Signed-off-by: Ludvig Liljenberg <[email protected]>
1 parent a53d8e0 commit 6a4539d

File tree

2 files changed

+32
-19
lines changed

2 files changed

+32
-19
lines changed

.github/release.yml

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,11 @@
33
changelog:
44
exclude:
55
labels:
6-
- chore
6+
- release-notes/ignore
77
categories:
8-
- title: 🎉 New Features or Improvements
8+
- title: New Features or Improvements
99
labels:
1010
- kind/enhancement
11-
- title: 🛠 Breaking Changes
12-
labels:
13-
- kind/breaking-change
14-
- title: 🐛 Bug Fixes
11+
- title: Bug Fixes
1512
labels:
1613
- kind/bugfix

docs/github-labels.md

Lines changed: 29 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,55 @@
11
# **PRs**
22

3-
To categorize PRs, we use GitHub labels. Before a PR can be merged, it must be assigned one of the following four labels, as these labels are used to generate automatic release notes:
3+
To categorize PRs, we use GitHub labels. Before a PR can be merged, it must be assigned one of the following **kind/** labels, as these labels are used to generate automatic release notes:
44

5-
- **kind/enhancement** – For PRs that add new features or improve existing functionality.
6-
- **kind/breaking-change** – For PRs that introduce changes that alter existing behavior.
7-
- **kind/bugfix** – For PRs that resolve bugs.
8-
- **kind/ignore** – For PRs that do not fit into the above categories and should be excluded from release notes, such as documentation updates, CI/CD tweaks, or minor test adjustments.
5+
- **kind/enhancement** - For PRs that add new features or improve existing functionality. This label should also be applied to PRs that improve documentation and testing, for example.
6+
- **kind/bugfix** - For PRs that resolve bugs.
7+
- **kind/refactor** - For PRs that improve code without changing its behavior.
8+
- **kind/dependencies** - For PRs that update dependencies or related components.
9+
10+
## PR release notes
11+
12+
GitHub release notes are automatically generated from PRs based on the assigned **kind/** labels, along with the PR title. To exclude PRs from release notes, add the **release-notes/ignore** label.
913

1014
---
1115

1216
# **Issues**
1317

1418
Issues are categorized using the following three **GitHub types** (not GitHub labels):
1519

16-
- **bug** Reports an unexpected problem or incorrect behavior.
17-
- **enhancement** Suggests a new feature, improvement, or idea.
18-
- **design** Relates to design considerations or decisions.
20+
- **bug** - Reports an unexpected problem or incorrect behavior.
21+
- **enhancement** - Suggests a new feature, improvement, or idea.
22+
- **design** - Relates to design considerations or decisions.
1923

2024
To track the lifecycle of issues, we also use GitHub labels:
2125

22-
- **lifecycle/needs-review** A temporary label indicating that the issue has not yet been reviewed.
23-
- **lifecycle/confirmed** Confirms the issue’s validity:
26+
- **lifecycle/needs-review** - A temporary label indicating that the issue has not yet been reviewed.
27+
- **lifecycle/confirmed** - Confirms the issue’s validity:
2428
- If the issue type is **bug**, the bug has been verified.
2529
- If the issue type is **enhancement**, the proposal has been deemed ready for implementation.
26-
- This label does not indicate when the fix or enhancement will be implemented. Unconfirmed issues are typically closed with an explanatory comment.
27-
- **lifecycle/needs-info** The issue requires additional information from the original poster (OP).
30+
- This label does not indicate when the fix or enhancement will be implemented.
31+
- **lifecycle/needs-info** - The issue requires additional information from the original poster (OP).
2832
- **lifecycle/blocked** - The issue is blocked by another issue or external factor.
2933

34+
The following labels should be applied to issues prior to closing, indicating the resolution status of the issue:
35+
36+
- **lifecycle/fixed** - The issue has been resolved.
37+
- **lifecycle/duplicate** - The issue is a duplicate of another issue.
38+
- **lifecycle/not-a-bug** - The issue is not considered a bug, and no further action is needed.
39+
- **lifecycle/wont-fix** - The issue will not be fixed.
40+
41+
In addition to lifecycle labels, we use the following labels to further categorize issues:
42+
43+
- **question** - The issue is a question or request for information.
44+
- **help-wanted** - The issue is a request for help or assistance.
45+
- **good-first-issue** - The issue is suitable for new contributors or those looking for a simple task to start with.
46+
3047
---
3148

3249
# **Issues & PRs**
3350

3451
In addition to **kind/*** labels, we use optional **area/*** labels to specify the focus of a PR or issue. These labels are purely for categorization, are not mandatory, and are not used for release notes.
3552

36-
- **area/dependencies** – Relates to dependency management and updates.
3753
- **area/documentation** – Related to documentation updates or improvements.
3854
- **area/infrastructure** – Concerns infrastructure rather than core functionality.
3955
- **area/performance** – Addresses performance.

0 commit comments

Comments
 (0)