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
Copy file name to clipboardExpand all lines: docs/github-labels.md
+8-7Lines changed: 8 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -2,10 +2,10 @@
2
2
3
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 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
5
-**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
6
-**kind/dependencies** - For PRs that update dependencies or related components.
7
+
-**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.
8
+
-**kind/refactor** - For PRs that restructure or remove code without adding new functionality. This label also applies to changes that affect user-facing APIs.
9
9
10
10
---
11
11
@@ -14,8 +14,8 @@ We use GitHub labels to categorize PRs. Before a PR can be merged, it must be as
14
14
Issues are categorized using the following three **GitHub types** (not GitHub labels):
15
15
16
16
-**bug** - Reports an unexpected problem or incorrect behavior.
17
-
-**enhancement** - Suggests a new feature, improvement, or idea.
18
17
-**design** - Relates to design considerations or decisions.
18
+
-**enhancement** - Suggests a new feature, improvement, or idea.
19
19
20
20
To track the lifecycle of issues, we also use GitHub labels:
21
21
@@ -29,25 +29,26 @@ To track the lifecycle of issues, we also use GitHub labels:
29
29
30
30
The following labels should be applied to issues prior to closing, indicating the resolution status of the issue:
31
31
32
-
-**lifecycle/fixed** - The issue has been resolved.
33
32
-**lifecycle/duplicate** - The issue is a duplicate of another issue.
33
+
-**lifecycle/fixed** - The issue has been resolved.
34
34
-**lifecycle/not-a-bug** - The issue is not considered a bug, and no further action is needed.
35
35
-**lifecycle/wont-fix** - The issue will not be fixed.
36
36
37
37
In addition to lifecycle labels, we use the following labels to further categorize issues:
38
38
39
-
-**question** - The issue is a question or request for information.
40
-
-**help-wanted** - The issue is a request for help or assistance.
41
39
-**good-first-issue** - The issue is suitable for new contributors or those looking for a simple task to start with.
40
+
-**help-wanted** - The issue is a request for help or assistance.
41
+
-**question** - The issue is a question or request for information.
42
42
43
43
---
44
44
45
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
49
-**area/API** - Related to the API or public interface.
50
+
-**area/dependencies** - Concerns dependencies or related components. This label is different from **kind/dependencies**, which should only used for PRs.
51
+
-**area/documentation** - Related to documentation updates or improvements.
51
52
-**area/infrastructure** - Concerns infrastructure rather than core functionality.
52
53
-**area/performance** - Addresses performance.
53
54
-**area/security** - Involves security-related changes or fixes.
0 commit comments