Skip to content

Commit cfdece3

Browse files
authored
Shorter PR template (#8571)
## Rational for this change While we've had a PR template for a while, we've not been very good at actually using it. This PR proposed a new shorter template, with somewhat more focused direction and less text. ## What changes are included in this PR? - New PR template. ## What APIs are changed? Are there any user-facing changes? N/A Signed-off-by: Adam Gutglick <adam@spiraldb.com>
1 parent 9abc307 commit cfdece3

1 file changed

Lines changed: 11 additions & 43 deletions

File tree

.github/pull_request_template.md

Lines changed: 11 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,23 @@
1-
<!--
2-
Thank you for submitting a pull request! We appreciate your time and effort.
3-
4-
Please make sure to provide enough information so that we can review your pull
5-
request. The Summary and Testing sections below contain guidance on what to
6-
include.
7-
-->
8-
9-
## Summary
1+
## Rational for this change
102

113
<!--
12-
If this PR is related to a tracked effort, please link to the relevant issue
13-
here (e.g., `Closes: #123`). Otherwise, feel free to ignore / delete this.
14-
15-
In this section, please:
16-
17-
1. Explain the rationale for this change.
18-
2. Summarize the changes included in this PR.
4+
Why are you proposing this change, and what is its impact.
5+
Is it part of a long term effort, or a bigger change?
196
20-
A general rule of thumb is that larger PRs should have larger summaries. If
21-
there are a lot of changes, please help us review the code by explaining what
22-
was changed and why.
23-
24-
If there is an issue or discussion attached, there is no need to duplicate all
25-
the details, but clarity is always preferred over brevity.
7+
If this PR is related to a tracked effort or an open issue, please link to the relevant issue.
268
-->
279

28-
Closes: #000
10+
- Closes: #000
2911

12+
## What changes are included in this PR?
3013
<!--
31-
## API Changes
32-
33-
Uncomment this section if there are any user-facing changes.
34-
35-
Consider whether the change affects users in one of the following ways:
36-
37-
1. Breaks public APIs in some way.
38-
2. Changes the underlying behavior of one of the engine integrations.
39-
3. Should some documentation be updated to reflect this change?
40-
41-
If a public API is changed in a breaking manner, make sure to add the
42-
appropriate label.
14+
No need to duplicate information from the previous section, but if you're touching many
15+
parts of the code base, its worth explicitly noting the important changes or how they are tested.
4316
-->
4417

45-
## Testing
18+
## What APIs are changed? Are there any user-facing changes?
4619

4720
<!--
48-
Please describe how this change was tested. Here are some common categories for
49-
testing in Vortex:
50-
51-
1. Verifying existing behavior is maintained.
52-
2. Verifying new behavior and functionality works correctly.
53-
3. Serialization compatibility (backwards and forwards) should be maintained or
54-
explicitly broken.
21+
Are there any user-facing changes that might require documentation updates
22+
Is any public API changed?
5523
-->

0 commit comments

Comments
 (0)