Skip to content

docs: add general labels documentation for issues and PRs #342

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

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

bjohansebas
Copy link
Member

This was discussed in #294 about having the labels documented at the organizational level, so that new triagers know how to use them. Part of this was extracted from https://github.com/jshttp/style-guide?tab=readme-ov-file#issue-label-use.

@bjohansebas
Copy link
Member Author

cc: @expressjs/triagers

Copy link
Member

@wesleytodd wesleytodd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In general this is GREAT. I added a few nitpick comments but will just drop an approval since I think they are easy to resolve.

| -------------------- | ----------------------------------------------------------------------------------- |
| `bug` | Denotes confirmed bugs. |
| `duplicate` | A duplicate issue. |
| `enhancement` | An issue requesting an enhancement. |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| `enhancement` | An issue requesting an enhancement. |
| `enhancement` | An issue requesting or implementing an enhancement. |

| `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. |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| `help wanted` | Extra help may be needed to resolve this issue. |
| `help wanted` | Help from the community is requested to assist in resolving this issue. |

| `enhancement` | An issue requesting an enhancement. |
| `help wanted` | Extra help may be needed to resolve this issue. |
| `invalid` | This is not a proper issue report, request, or question. |
| `question` | For issues where the issuer is asking something. |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have been moving these into discussions, which IMO is better than using a label. Could we just remove this?

Comment on lines +18 to +21
- `needs triage`: This can be kept if the triager is unsure which next steps to take
- `awaiting more info`: If more info has been requested from the author, apply this label.
- `bug`: Issues that present a reasonable conviction there is a reproducible bug.
- `enhancement`: Issues that are found to be a reasonable candidate feature additions.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These changes were made by the linter

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants