-
Notifications
You must be signed in to change notification settings - Fork 139
Document label meaning #298
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
ludfjig marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
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. | ||
|
||
ludfjig marked this conversation as resolved.
Show resolved
Hide resolved
|
||
--- | ||
ludfjig marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
# **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. | ||
danbugs marked this conversation as resolved.
Show resolved
Hide resolved
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.