diff --git a/.github/workflows/pr_checklist.md b/.github/workflows/pr_checklist.md index 873e7512f..ee9db22d3 100644 --- a/.github/workflows/pr_checklist.md +++ b/.github/workflows/pr_checklist.md @@ -1,21 +1,13 @@ -If you haven't seen them already, please review [CONTRIBUTIONS.md](https://github.com/datastax/jvector/blob/main/CONTRIBUTIONS.md) - -## Summary of Changes - ---- - -Explain here why this PR is being submitted, it's purpose and impact for users. - ---- - -### Checklist before you submit for review +__Before you submit for review:__ +- [ ] Does your PR follow guidelines from [CONTRIBUTIONS.md](https://github.com/datastax/jvector/blob/main/CONTRIBUTIONS.md)? +- [ ] Did you summarize what this PR does clearly and concisely? - [ ] Did you include performance data for changes which may be performance impacting? - [ ] Did you include useful docs for any user-facing changes or features? - [ ] Did you include useful javadocs for developer oriented changes, explaining new concepts or key changes? -- [ ] Did you trigger and review regression testing results against the base branch via `Run Bench Main`? +- [ ] Did you trigger and review regression testing results against the base branch via [Run Bench Main](https://github.com/datastax/jvector/actions/workflows/run-bench.yml)? - [ ] Did you adhere to the code formatting guidelines (TBD) - [ ] Did you group your changes for easy review, providing meaningful descriptions for each commit? - [ ] Did you ensure that all files contain the correct copyright header? -If you did not complete any of these, then please explain below +If you did not complete any of these, then please explain below. diff --git a/CONTRIBUTIONS.md b/CONTRIBUTIONS.md index 1e740a6d6..110134e7d 100644 --- a/CONTRIBUTIONS.md +++ b/CONTRIBUTIONS.md @@ -1,6 +1,6 @@ # JVector Contribution Guidelines -## Core Requirements for Pull Requests +## Pull Requests - PRs adhere to the checklists posted in the comments. - PRs may only be merged after: