It's important to recognize the value of proper labeling for issues and discussions when a project operates at scale. Without this organization, it makes for extra workload on the project maintainers as it requires a detailed review of each unlabeled issue to set in motion any further workflows, both automated and manual.
Please consider the following document when creating new issues or discussions. If an issue or discussion isn't properly labeled per the following standards, it may result in notable delays before a project maintainer addresses the issue or discussion.
This category should be used to report any mis-behaving / broken feature, changes that break functionality or usability, and most importantly, security vulnerabilities.
| Property | Value |
|---|---|
| Color | #d73a4a |
| Pattern | bug / * |
This category should be used to hold any discussions of existing project documentation as well as making new documentation requests.
| Property | Value |
|---|---|
| Color | #0075ca |
| Pattern | docs / * |
This category should be used to hold any discussions of existing features as well as making new feature or enhancement requests.
| Property | Value |
|---|---|
| Color | #008672 |
| Pattern | feature / * |
This category should be used to request help with the various aspects of using the application.
| Property | Value |
|---|---|
| Color | #d876e3 |
| Pattern | help / * |
This category should only be used by project maintainers for use in management workflows.
| Property | Value |
|---|---|
| Color | #e5ef23 |
| Pattern | mod / * |
This category should only be used by project maintainers to categorize the skills required for addressing a topic.
| Property | Value |
|---|---|
| Color | #5319e7 |
| Pattern | skill / * |
Below is a list of all labels currently used on the project for organizing issues, discussions, and pull-requests.
| Label | When to use it |
|---|---|
| bug / broken-feature | Existing feature malfunctioning or broken |
| bug / security-vulnerability | Security vulnerability identified with the application |
| docs / discussion | Documentation change proposals |
| docs / request | Documentation change request |
| feature / dependency | Existing feature dependency |
| feature / discussion | New or existing feature discussion |
| feature / request | New feature or enhancement request |
| help / deployment | Questions regarding application deployment |
| help / features | Questions regarding the use of application features |
| help / other | General questions not specific to application deployment or features |
| mod / accepted | This request has been accepted |
| mod / announcement | This is an admin announcement |
| mod / change-request | Used by internal developers to indicate a change-request. |
| mod / changes-requested | Changes have been requested before proceeding |
| mod / duplicate | This issue or pull request already exists |
| mod / good-first-issue | Good for newcomers |
| mod / help-wanted | Extra attention is needed |
| mod / invalid | This doesn't seem right |
| mod / rejected | This request has been rejected |
| mod / reviewed | This request has been reviewed |
| mod / reviewing | This request is being reviewed |
| mod / stale | This request has gone stale |
| mod / tested | This has been tested |
| mod / testing | This is being tested |
| mod / wont-fix | This will not be worked on |
| skill / database | Requires a database skill-set |
| skill / docker | Requires a Docker skill-set |
| skill / documentation | Requires a documentation skill-set |
| skill / html | Requires a HTML skill-set |
| skill / javascript | Requires a JavaScript skill-set |
| skill / python | Requires a Python skill-set |