Skip to content

Commit

Permalink
chore: add labels docs (#55)
Browse files Browse the repository at this point in the history
Signed-off-by: Charles-Edouard Brétéché <[email protected]>
  • Loading branch information
eddycharly authored Oct 5, 2023
1 parent 6f1cddc commit 5bcdc2b
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/dev/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
This documentation contains the following dev docs:

- [Release docs](./release/README.md)
- [Labels docs](./labels/README.md)
24 changes: 24 additions & 0 deletions docs/dev/labels/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Labels docs

This docs contains informations on how we use GitHub labels on issues and pull requests.

## Labels

| Name | Issue | PR | Usage |
|---|---|---|---|
| `bug` | :whitecheckmark: | | Indentifies reported bugs |
| `cherry pick required` | | :whitecheckmark: | Indentifies pull requests that need to be cherry picked |
| `cherry pick completed` | | :whitecheckmark: | Indentifies pull requests that were successfully cherry picked |
| `dependencies` | | :whitecheckmark: | Indentifies pull requests updating a dependency |
| `documentation` | :whitecheckmark: | | Indentifies issues related to documentation |
| `documentation required` | | :whitecheckmark: | Indentifies pull requests that need to be documented |
| `documentation completed` | | :whitecheckmark: | Indentifies pull requests that were successfully documented |
| `duplicate` | :whitecheckmark: | :whitecheckmark: | Identifies a duplicate issue or pull request |
| `enhancement` | :whitecheckmark: | | Indentifies feature requests |
| `github_actions` | | :whitecheckmark: | Indentifies pull requests related to GitHub actions |
| `go` | | :whitecheckmark: | Indentifies pull requests related to `golang` packages |
| `good first issue` | :whitecheckmark: | | Indentifies issues that are well suited for new contributors |
| `help want` | :whitecheckmark: | | Indentifies issues that need help from the community |
| `release notes required` | | :whitecheckmark: | Indentifies pull requests that need release notes |
| `release notes completed` | | :whitecheckmark: | Indentifies pull requests that have a corresponding release note |
| `triage` | :whitecheckmark: | | Indentifies issues that need to be triaged |

0 comments on commit 5bcdc2b

Please sign in to comment.