Files
my-rook-config/.github/PULL_REQUEST_TEMPLATE.md
Joshua Hoblitt d900c61b84 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>
2026-07-27 16:25:27 -07:00

1.6 KiB

Checklist:

  • Commit Message Formatting: Commit titles and messages follow guidelines in the developer guide.
  • Reviewed the developer guide on Submitting a Pull Request
  • Reviewed AI guidelines, if AI assisted with the PR.
  • Pending release notes 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).