Skip to content

Commit cfb3004

Browse files
jshookJonathan Shook
andauthored
streamline PR checklist (#525)
Co-authored-by: Jonathan Shook <jshook1@ibm.com>
1 parent df4a068 commit cfb3004

File tree

2 files changed

+6
-14
lines changed

2 files changed

+6
-14
lines changed

.github/workflows/pr_checklist.md

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,13 @@
1-
If you haven't seen them already, please review [CONTRIBUTIONS.md](https://github.com/datastax/jvector/blob/main/CONTRIBUTIONS.md)
2-
3-
## Summary of Changes
4-
5-
---
6-
7-
Explain here why this PR is being submitted, it's purpose and impact for users.
8-
9-
---
10-
11-
### Checklist before you submit for review
1+
__Before you submit for review:__
122

3+
- [ ] Does your PR follow guidelines from [CONTRIBUTIONS.md](https://github.com/datastax/jvector/blob/main/CONTRIBUTIONS.md)?
4+
- [ ] Did you summarize what this PR does clearly and concisely?
135
- [ ] Did you include performance data for changes which may be performance impacting?
146
- [ ] Did you include useful docs for any user-facing changes or features?
157
- [ ] Did you include useful javadocs for developer oriented changes, explaining new concepts or key changes?
16-
- [ ] Did you trigger and review regression testing results against the base branch via `Run Bench Main`?
8+
- [ ] 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)?
179
- [ ] Did you adhere to the code formatting guidelines (TBD)
1810
- [ ] Did you group your changes for easy review, providing meaningful descriptions for each commit?
1911
- [ ] Did you ensure that all files contain the correct copyright header?
2012

21-
If you did not complete any of these, then please explain below
13+
If you did not complete any of these, then please explain below.

CONTRIBUTIONS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# JVector Contribution Guidelines
22

3-
## Core Requirements for Pull Requests
3+
## Pull Requests
44

55
- PRs adhere to the checklists posted in the comments.
66
- PRs may only be merged after:

0 commit comments

Comments
 (0)