upstream/helm
1
0
Fork 0
mirror of https://github.com/helm/helm.git synced 2026-05-28 04:35:48 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

docs: Introduce docs wanted label

Browse source 
Signed-off-by: George Jenkins <gvjenkins@gmail.com>
This commit is contained in:
George Jenkins 2024-07-22 10:12:08 -07:00
parent cd71a359bf
commit cd92c431d0
2 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.github/pull_request_template.md vendored
View file

@ -7,6 +7,6 @@
**Special notes for your reviewer**:
**If applicable**:
- [ ] this PR contains documentation
- [ ] this PR contains user facing changes (`docs wanted` label should be applied if so)
- [ ] this PR contains unit tests
- [ ] this PR has been tested for backwards compatibility

7
CONTRIBUTING.md
View file

@ -262,9 +262,9 @@ Like any good open source project, we use Pull Requests (PRs) to track code chan
#### Documentation PRs
Documentation PRs will follow the same lifecycle as other PRs. They will also be labeled with the
`docs` label. For documentation, special attention will be paid to spelling, grammar, and clarity
(whereas those things don't matter *as* much for comments in code).
Documentation PRs should be made on the docs repo: <https://github.com/helm/helm-www>. Keeping Helm's documentation up to date is highly desirable, and it is recommend all user facing changes. Accurate and helpful documentation is critical for effectively communicating Helm's behavior to a wide audience.
Small, ad-hoc changes/PRs to Helm which introduce user facing changes which would benefit from documentation changes should be labeled `docs wanted`. Larger changes associated with a HIP should track docs via that HIP. The `docs wanted` label doesn't block PRs, and maintainers/PR reviewers should apply discretion judging if the `docs wanted` label should be applied.| `bug` | Marks an issue as a bug or a PR as a bugfix |
## The Triager
@ -307,6 +307,7 @@ The following tables define all label types used for Helm. It is split up by cat
| `needs rebase` | Indicates a PR needs to be rebased before it can be merged |
| `needs pick` | Indicates a PR needs to be cherry-picked into a feature branch (generally bugfix branches). Once it has been, the `picked` label should be applied and this one removed |
| `picked` | This PR has been cherry-picked into a feature branch |
| `docs wanted` | Tracks PRs that introduces a feature/change for which documentation update would be desirable (non-blocking). Once a suitable docs PR is created this label should be removed |
#### Size labels