dingo-d
commented
5 years ago Current labels
bug - there is a bug in a plugin.
duplicate - this issue has been asked.
enhancement - this issue is not a bug but an enhancement, or a new feature.
future release - this issue will be fixed in the future release, or the enhancement will be implemented in the future release.
good first issue - this is a good first issue, something a new contributor can work on.
help wanted - help is needed regarding an issue.
invalid - this issue is not valid or not applicable to the plugin.
issue: bug - this issue is a bug.
issue: has PR - this issue has an opened PR.
issue: needs PR - this issue needs a PR.
issue: question - this issue is a question.
possible bug - this issue is a possible bug, but might not be (could be a misunderstanding or a false positive).
pr: needs refresh - this PR needs a refresh.
pr: needs review - this PR needs a review.
pr: needs update - this PR needs an update.
pr: wait for upstream - this PR relies on an upstream issue to be solved before it can be fixed/updated.
question - this is a question.
second opinion - second opinion is needed on the issue/enhancement.
upstream issue - this is an upstream issue, either in the WPCS, WPThemeReview or PHPCS.
Proposal
A lot of these labels are not used, duplicates or just plain not needed. The proposal is to reduce their number and add the description next to every one used. The influence for the naming comes from the WPCS repo.
The labels will be categorised.
Type
Certain issues or PRs can be bug reports, some can be related to creating a documentation, reporting an enhancement or just asking a question. The following labels would be renamed and added
bug -> Type: Bug - There is a bug in the plugin (will be automatically assigned to a bug template once PR #151 is merged).
enhancement -> Type: Enhancement - This is an enhancement of the existing features or a new feature to the plugin (extra validations and checks outside PHP_CodeSniffer capability). Should be added to a new enhancement template.
question -> Type: Question - This is a question regarding the functionality of the plugin.
To add:
Type: Documentation - Issue that is not code related but documentation related.
Status
These labels will mark a status of an issue or a PR.
duplicate -> Status: Duplicate - Issue has been asked already. After an issue is marked as duplicate it should be closed.
future release -> Status: Future Release - This issue will be fixed in the future release of the plugin, or an enhancement will be added in the next plugin version.
good first issue -> Status: Good First Issue - This is a good first issue, something a new contributor can work on (useful for WordCamp contributor days).
help wanted -> Status: Help Wanted - A help is needed regarding an issue or an opened PR.
invalid -> Status: Invalid - This issue is not valid or not applicable to the plugin.
possible bug -> Status: Possible Bug - This issue is a possible bug, but might not be (could be a misunderstanding or a false positive).
second opinion -> Status: Second Opinion - Second opinion is needed on the issue/enhancement.
upstream issue -> Status: Upstream Issue - This is an upstream issue, either in the WPCS, WPThemeReview or PHPCS.
To add:
Status: Awaiting Feedback - The issue needs more feedback from people with more experience about it.
To delete:
The following labels should be deleted, as they are either not used, or duplicate labels:
issue: bug
issue: has PR
issue: needs PR
issue: question
pr: needs refresh
pr: needs review
pr: needs update
pr: wait for upstream
If anyone has more comments leave them, if not, I'll start reorganising this on Monday probably 🙂
Like in the WPCS repo (link) we should make a good list/suggestion of reorganising labels in the repo.
See which ones we use, which we don't and can be removed. Also the labels that will stay should be a bit better explained 🙂
Help is welcomed