Labeling Template

[AustinCasteel]

Assignment to Issues or Pull Requests

Most of the labels can be applied to both Issues and Pull Requests, however for some labels, they may not make sense to apply it to one or the other.

Combinations

An issue or PR should only have one label from the Priority category, and one from the Type category. It may make sense to combine some Status category labels to an issue or PR, but not others.

For example, it makes sense for an issue to be both In Progress and On Hold. The issue may have someone assigned who has started work, but is waiting for another issue to be completed first, allowing them to focus on one thing at a time. However, an issue In Progress cannot also be Abandoned

All issues and pull requests have to have a Priority assigned to them

This should be dealt with ASAP. Not fixing this issue would be a serious error

After critical issues are fixed, these should be dealt with before any further issues.

This issue may be useful, and needs some attention.

This issue can probably be picked up by anyone looking to contribute to the project, as an entry fix.

All issues and pull requests have to have a Type assigned to them

Inconsistencies or issues which will cause an issue or problem for users.

Most issues will probably ask for additions or changes. It's expected that this type of issue will result in a Pull Request.

Updating phrasing or wording to make things clearer or removing ambiguity, without changing the functionality.

A query or seeking clarification on parts of the spec. Probably doesn't need the attention of everyone, just a few to help bring clarification or explain intent.

All issues and pull requests have to have a Status assigned to them

This will be altered throughout the issue and pr process by maintainers

No one has claimed responsibility for resolving this issue. Generally this will be applied to bugs and enhancement issues, but may be applied to others.

There is another issue or PR that needs to be resolved first, or a specific person is required to comment or reply to progress. There may also be some external blocker.

Nothing further to be done with this issue or PR. Awaiting to be closed by the requester out of politeness, or can be closed by a maintainer. (i.e. a question was answered and the issue no longer needs to be open. Or if a PR has been reviewed and passed, the PR and associated issue will be labeled as complete and they will be merged/closed.)

This issue or PR is being worked on, and has someone assigned.

Similar to blocked, but is assigned to someone. May also be assigned to someone because of their experience, but it's recognized they are unable to process the issue at this time.

The issue or PR status is unknown. Pending issues & PR status is up to maintainers to decide if they want to proceed or abandon.

The issue or PR needs to be reviewed. A PR should receive a review by at least one maintainer. If passed the Pr will be merged, the associated issue will be closed, & both will be labeled as complete.

Either someone has seen issues in the PR that makes them uneasy or a review did not pass. Submitter of PR needs to revise the PR to proceed and request a new review when ready.

It's believed that this issue is no longer important to the requester, no one else has shown an interest in it, or no longer aligns with the scope of the project.

If you are new to the project and want to get involved but do not know where to start, any issue with this label is the perfect place.