Skip to content

Commit 2031213

Browse files
authored
chore(pr-template) Fix PR template (kroxylicious#3840)
* chore(pr-template) Fix PR template Updated the PR checklist to clarify testing requirements. Signed-off-by: Keith Wall <kwall@apache.org> * address review comments Signed-off-by: Keith Wall <kwall@apache.org> --------- Signed-off-by: Keith Wall <kwall@apache.org>
1 parent 3c10630 commit 2031213

3 files changed

Lines changed: 21 additions & 13 deletions

File tree

.claude/rules/pull-requests.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Pull Request Requirements
2+
3+
## Template
4+
5+
When creating pull requests, follow the checklist in [.github/PULL_REQUEST_TEMPLATE.md](../../.github/PULL_REQUEST_TEMPLATE.md).
6+
7+
## Key Points for Claude
8+
9+
- The template checklist is evaluated before merging, not necessarily before opening the PR
10+
- Always include `Assisted-by:` trailer in commits (see commit conventions)
11+
- For Sonarcloud warnings: either fix them or suppress with `@SuppressWarnings` plus justifying comment

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,13 @@ _Why are you making this pull request?_
1717

1818
### Checklist
1919

20-
_Please go through this checklist and make sure all applicable tasks have been done_
21-
22-
- [ ] PR raised from a fork of this repository and made from a branch rather than main.
23-
- [ ] Write tests
24-
- [ ] Update documentation
25-
- [ ] Make sure all unit/integration tests pass
26-
- [ ] Make sure all Sonarcloud warnings are addressed or are justifiably ignored.
27-
- [ ] If applicable to the change, make sure system tests pass.
28-
- [ ] If applicable to the change, [trigger the performance test suite](../blob/main/PERFORMANCE.md#jenkins-pipeline-for-performance). Ensure that any degradations to performance numbers are understood and justified.
29-
- [ ] Ensure the PR references relevant issue(s) so they are closed on merging.
30-
- [ ] For user facing changes, update CHANGELOG.md (remember to include changes affecting the API of the test artefacts too).
20+
The checklist is used to help Committers judge a PR's readiness for merge.
21+
Contributors: please check off items you consider done.
22+
23+
- [ ] New tests written (where applicable).
24+
- [ ] User facing documentation written/updated (where applicable).
25+
- [ ] Existing unit/integration/system tests passing.
26+
- [ ] Any Sonarcloud warnings are addressed (or suppressed with `@SuppressWarnings` and a justifying comment).
27+
- [ ] PR references related GitHub issue(s) so they are closed on merging.
3128
- [ ] If AI tools assisted with code changes, ensure commit messages include `Assisted-by:` trailer (see [DEV_GUIDE.md](../blob/main/DEV_GUIDE.md#ai-disclosure-requirement)).
32-
33-
> **_NOTE:_** You must be a member of `@kroxylicious/developers` to trigger the system test and performance test suites. If you are not part of this group, comment on the PR requesting a trigger, tagging `@kroxylicious/developers`.
29+
- [ ] For user facing changes, update CHANGELOG.md (remember to include changes affecting the API of the test artefacts too).

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ When writing code, follow these prescriptive rules:
3131
- [Security](.claude/rules/security-patterns.md) - Security coding requirements
3232
- [Logging](.claude/rules/logging.md) - Logging conventions
3333
- [Documentation](.claude/rules/documentation-requirements.md) - When to write docs
34+
- [Pull Requests](.claude/rules/pull-requests.md) - PR checklist requirements
3435

3536
## Commit Conventions
3637

0 commit comments

Comments
 (0)