From cd92c431d0ae8ed34fa31fe5fa2637b55c33bdce Mon Sep 17 00:00:00 2001 From: George Jenkins Date: Mon, 22 Jul 2024 10:12:08 -0700 Subject: [PATCH] docs: Introduce `docs wanted` label Signed-off-by: George Jenkins --- .github/pull_request_template.md | 2 +- CONTRIBUTING.md | 7 ++++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index cda9086dd..f55e0e4db 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 20015e60a..e86004bfa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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: . 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