You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
4
4
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.
8
8
-**kind/dependencies** - For PRs that update dependencies or related components.
9
9
10
10
---
11
11
12
-
# **Issues**
12
+
# **Issues**
13
13
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):
15
15
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.
19
19
20
-
To track the lifecycle of issues, we also use GitHub labels:
20
+
To track the lifecycle of issues, we also use GitHub labels:
21
21
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.
27
27
-**lifecycle/needs-info** - The issue requires additional information from the original poster (OP).
28
28
-**lifecycle/blocked** - The issue is blocked by another issue or external factor.
29
29
@@ -42,13 +42,17 @@ In addition to lifecycle labels, we use the following labels to further categori
42
42
43
43
---
44
44
45
-
# **Issues & PRs**
45
+
# **Issues & PRs**
46
46
47
47
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.
48
48
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