Skip to content
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.

Sign up for GitHub

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

chore: add labels docs #55

Merged
merged 2 commits into from
Oct 5, 2023
Merged

chore: add labels docs #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ad740b7
chore: add labels docs
eddycharly Oct 5, 2023
9bc8e3a
Merge branch 'main' into labels-docs
eddycharly Oct 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/dev/README.md
View file
Open in desktop
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
View file
Open in desktop
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 |