diff --git a/docs/github-labels.md b/docs/github-labels.md new file mode 100644 index 000000000..888b0280d --- /dev/null +++ b/docs/github-labels.md @@ -0,0 +1,59 @@ +# **Pull Requests (PRs)** + +We use GitHub labels to categorize PRs. Before a PR can be merged, it must be assigned one of the following **kind/** labels: + +- **kind/bugfix** - For PRs that fix bugs. +- **kind/dependencies** - For PRs that update dependencies or related components. +- **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. +- **kind/refactor** - For PRs that restructure or remove code without adding new functionality. This label also applies to changes that affect user-facing APIs. + +--- + +# **Issues** + +Issues are categorized using the following three **GitHub types** (not GitHub labels): + +- **bug** - Reports an unexpected problem or incorrect behavior. +- **design** - Relates to design considerations or decisions. +- **enhancement** - Suggests a new feature, improvement, or idea. + +To track the lifecycle of issues, we also use GitHub labels: + +- **lifecycle/needs-review** - A temporary label indicating that the issue has not yet been reviewed. +- **lifecycle/confirmed** - Confirms the issue’s validity: + - If the issue type is **bug**, the bug has been verified. + - If the issue type is **enhancement**, the proposal is considered reasonable but does not guarantee implementation. + - This label does not indicate when or if the fix or enhancement will be implemented. +- **lifecycle/needs-info** - The issue requires additional information from the original poster (OP). +- **lifecycle/blocked** - The issue is blocked by another issue or external factor. + +The following labels should be applied to issues prior to closing, indicating the resolution status of the issue: + +- **lifecycle/duplicate** - The issue is a duplicate of another issue. +- **lifecycle/fixed** - The issue has been resolved. +- **lifecycle/not-a-bug** - The issue is not considered a bug, and no further action is needed. +- **lifecycle/wont-fix** - The issue will not be fixed. + +In addition to lifecycle labels, we use the following labels to further categorize issues: + +- **good-first-issue** - The issue is suitable for new contributors or those looking for a simple task to start with. +- **help-wanted** - The issue is a request for help or assistance. +- **question** - The issue is a question or request for information. + +--- + +# **Issues & PRs** + +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. + +- **area/API** - Related to the API or public interface. +- **area/dependencies** - Concerns dependencies or related components. This label is different from **kind/dependencies**, which should only used for PRs. +- **area/documentation** - Related to documentation updates or improvements. +- **area/infrastructure** - Concerns infrastructure rather than core functionality. +- **area/performance** - Addresses performance. +- **area/security** - Involves security-related changes or fixes. +- **area/testing** - Related to tests or testing infrastructure. + + +## Notes +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. \ No newline at end of file