docs: add general labels documentation for issues and PRs #342
There are no files selected for viewing
This file contains 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,38 @@ | ||||||
| # General labels | ||||||
|
|
||||||
| Express has the following labels available to tag each issue and PR that has been opened | ||||||
|
|
||||||
| | Name | Description | | ||||||
| | -------------------- | ----------------------------------------------------------------------------------- | | ||||||
| | `bug` | Denotes confirmed bugs. | | ||||||
| | `duplicate` | A duplicate issue. | | ||||||
| | `enhancement` | An issue requesting an enhancement. | | ||||||
| | `help wanted` | Extra help may be needed to resolve this issue. | | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| | `invalid` | This is not a proper issue report, request, or question. | | ||||||
| | `question` | For issues where the issuer is asking something. | | ||||||
|
There was a problem hiding this comment. We have been moving these into discussions, which IMO is better than using a label. Could we just remove this? |
||||||
| | `wontfix` | Marks an issue that will not be fixed. | | ||||||
| | `docs` | This issue pertains to the documentation or code comments. | | ||||||
| | `investigate` | Requires further investigation. | | ||||||
| | `tests` | This issue pertains to the tests themselves. | | ||||||
| | `deprecate` | Issue is about a feature that is pending future removal. | | ||||||
| | `release` | A tracking issue for a specific release milestone. | | ||||||
| | `ideas` | Marks an issue which is primarily an idea. | | ||||||
|
There was a problem hiding this comment. I am not sure how this is different from |
||||||
| | `discuss` | This issue should remain open to discussion for a while. | | ||||||
| | `needs tests` | This pull request needs tests to be added. | | ||||||
| | `needs docs` | This pull request needs documentation to be added. | | ||||||
| | `needs rebase` | This pull request needs rebase to be added. | | ||||||
| | `future` | An issue which should be resolved in a future release. | | ||||||
|
There was a problem hiding this comment. I would rather drop this in favor of specific semver major tags. |
||||||
| | `deps` | Marks a dependancy-related issue or pull request. | | ||||||
| | `low priority` | Denotes a low-priority issue. | | ||||||
| | `question` | Issues that look for answers. | | ||||||
|
There was a problem hiding this comment. This line is duplicated from line 12. |
||||||
| | `tc agenda` | Issues that will be discussed in the TC meetings. | | ||||||
| | `top priority` | Issues that will be discussed in the working sessions. | | ||||||
| | `fast track` | PRs that are quick changes, like fixing a spelling mistake. | | ||||||
| | `meta` | Issues and PRs related to the general management of the project. | | ||||||
| | `semver-major` | PRs that have a breaking change. | | ||||||
| | `semver-minor` | PRs that add a new feature and do not break compatibility. | | ||||||
| | `semver-patch` | PRs that fix a bug in the code without breaking compatibility. | | ||||||
| | `feedback` | PRs that require feedback from the community. | | ||||||
| | `require-triage` | Issues and PRs that have been opened but have not been reviewed for the first time. | | ||||||
| | `awaiting more info` | Issues that require more information for better understanding. | | ||||||
| | `good first issue` | Issues suitable for newcomers to fix | | ||||||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.