|
| 1 | +# **Pull Requests (PRs)** |
| 2 | + |
| 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 | + |
| 5 | +- **kind/bugfix** - For PRs that fix bugs. |
| 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 | + |
| 10 | +--- |
| 11 | + |
| 12 | +# **Issues** |
| 13 | + |
| 14 | +Issues are categorized using the following three **GitHub types** (not GitHub labels): |
| 15 | + |
| 16 | +- **bug** - Reports an unexpected problem or incorrect behavior. |
| 17 | +- **design** - Relates to design considerations or decisions. |
| 18 | +- **enhancement** - Suggests a new feature, improvement, or idea. |
| 19 | + |
| 20 | +To track the lifecycle of issues, we also use GitHub labels: |
| 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 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 | +- **lifecycle/needs-info** - The issue requires additional information from the original poster (OP). |
| 28 | +- **lifecycle/blocked** - The issue is blocked by another issue or external factor. |
| 29 | + |
| 30 | +The following labels should be applied to issues prior to closing, indicating the resolution status of the issue: |
| 31 | + |
| 32 | +- **lifecycle/duplicate** - The issue is a duplicate of another issue. |
| 33 | +- **lifecycle/fixed** - The issue has been resolved. |
| 34 | +- **lifecycle/not-a-bug** - The issue is not considered a bug, and no further action is needed. |
| 35 | +- **lifecycle/wont-fix** - The issue will not be fixed. |
| 36 | + |
| 37 | +In addition to lifecycle labels, we use the following labels to further categorize issues: |
| 38 | + |
| 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 | + |
| 43 | +--- |
| 44 | + |
| 45 | +# **Issues & PRs** |
| 46 | + |
| 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 | + |
| 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. |
| 52 | +- **area/infrastructure** - Concerns infrastructure rather than core functionality. |
| 53 | +- **area/performance** - Addresses performance. |
| 54 | +- **area/security** - Involves security-related changes or fixes. |
| 55 | +- **area/testing** - Related to tests or testing infrastructure. |
| 56 | + |
| 57 | + |
| 58 | +## Notes |
| 59 | +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