Skip to content

Commit 3083405

Browse files
committed
Some feedback
Signed-off-by: Ludvig Liljenberg <[email protected]>
1 parent 42bc2fd commit 3083405

File tree

1 file changed

+27
-23
lines changed

1 file changed

+27
-23
lines changed

docs/github-labels.md

Lines changed: 27 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
1-
# **PRs**
1+
# **Pull Requests (PRs)**
22

3-
To categorize PRs, we use GitHub labels. Before a PR can be merged, it must be assigned one of the following **kind/** labels.
3+
We use GitHub labels to categorize PRs. Before a PR can be merged, it must be assigned one of the following **kind/** labels:
44

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.
5+
- **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.
6+
- **kind/bugfix** - For PRs that fix bugs.
7+
- **kind/refactor** - For PRs that restructure or remove code without adding new functionality. This label also applies to changes that affect user-facing APIs.
88
- **kind/dependencies** - For PRs that update dependencies or related components.
99

1010
---
1111

12-
# **Issues**
12+
# **Issues**
1313

14-
Issues are categorized using the following three **GitHub types** (not GitHub labels):
14+
Issues are categorized using the following three **GitHub types** (not GitHub labels):
1515

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.
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.
1919

20-
To track the lifecycle of issues, we also use GitHub labels:
20+
To track the lifecycle of issues, we also use GitHub labels:
2121

22-
- **lifecycle/needs-review** - A temporary label indicating that the issue has not yet been reviewed.
23-
- **lifecycle/confirmed** - Confirms the issue’s validity:
24-
- If the issue type is **bug**, the bug has been verified.
25-
- 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.
22+
- **lifecycle/needs-review** - A temporary label indicating that the issue has not yet been reviewed.
23+
- **lifecycle/confirmed** - Confirms the issue’s validity:
24+
- If the issue type is **bug**, the bug has been verified.
25+
- If the issue type is **enhancement**, the proposal is considered reasonable but does not guarantee implementation.
26+
- This label does not indicate when or if the fix or enhancement will be implemented.
2727
- **lifecycle/needs-info** - The issue requires additional information from the original poster (OP).
2828
- **lifecycle/blocked** - The issue is blocked by another issue or external factor.
2929

@@ -42,13 +42,17 @@ In addition to lifecycle labels, we use the following labels to further categori
4242

4343
---
4444

45-
# **Issues & PRs**
45+
# **Issues & PRs**
4646

4747
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, and are not mandatory.
4848

49-
- **area/documentation** – Related to documentation updates or improvements.
50-
- **area/API** – Related to the API or public interface.
51-
- **area/infrastructure** – Concerns infrastructure rather than core functionality.
52-
- **area/performance** – Addresses performance.
53-
- **area/security** – Involves security-related changes or fixes.
54-
- **area/testing** – Related to tests or testing infrastructure.
49+
- **area/documentation** - Related to documentation updates or improvements.
50+
- **area/API** - Related to the API or public interface.
51+
- **area/infrastructure** - Concerns infrastructure rather than core functionality.
52+
- **area/performance** - Addresses performance.
53+
- **area/security** - Involves security-related changes or fixes.
54+
- **area/testing** - Related to tests or testing infrastructure.
55+
56+
57+
## Notes
58+
This document is a work in progress and may be updated as needed. The labels and categories are subject to change based on the evolving needs of the project and community feedback.

0 commit comments

Comments
 (0)