Files
my-rook-config/.github/PULL_REQUEST_TEMPLATE.md
T
Joshua Hoblitt 52d171c45f docs: clarify what each pull request checklist item claims
Three of the checklist items say "if necessary" without saying what would make
them necessary, and a box ticked without a matching change misleads the reviewer
who reads the checklist as a claim about the diff. The deciding criterion in
each case is simply which folder the change touches.

State that folder next to each item, so the test is visible where the box is
ticked and needs no judgement to apply.

Signed-off-by: Joshua Hoblitt <josh@hoblitt.com>
(cherry picked from commit d900c61b84)
2026-08-06 19:55:06 +00:00

26 lines
1.6 KiB
Markdown

<!-- Thank you for contributing to Rook! -->
<!-- STEPS TO FOLLOW:
1. Add a description of the changes (frequently the same as the commit description)
2. Enter the issue number next to "Resolves #" below (if there is no tracking issue resolved, **remove that section**)
3. Review our Contributing documentation at https://rook.io/docs/rook/latest/Contributing/development-flow/
4. Follow the steps in the checklist below, starting with the **Commit Message Formatting**.
-->
<!-- Uncomment this section with the issue number if an issue is being resolved
**Issue resolved by this Pull Request:**
Resolves #
--->
**Checklist:**
- [ ] **Commit Message Formatting**: Commit titles and messages follow guidelines in the [developer guide](https://rook.io/docs/rook/latest/Contributing/development-flow/#commit-structure).
- [ ] Reviewed the developer guide on [Submitting a Pull Request](https://rook.io/docs/rook/latest/Contributing/development-flow/#submitting-a-pull-request)
- [ ] Reviewed [AI guidelines](https://rook.io/docs/rook/latest/Contributing/ai-guidelines), if AI assisted with the PR.
- [ ] [Pending release notes](https://github.com/rook/rook/blob/master/PendingReleaseNotes.md) updated with breaking and/or notable changes for the next minor release.
- Overwriting Ceph's configurations should be marked as breaking changes.
- [ ] Documentation has been updated, if necessary (under the `Documentation` folder).
- [ ] Unit tests have been added, if necessary (`_test.go` files under the `cmd` and `pkg` folders).
- [ ] Integration tests have been added, if necessary (in the `tests/integration` folder).