Skip to content

Commit 5fa86c9

Browse files
authored
Alternative, concise PR template (#2945)
This PR proposes an alternative PR template that is much shorter, and removes all the redundant claims. It also links to the contribution guidelines for further guidance.
1 parent 8c6e322 commit 5fa86c9

File tree

1 file changed

+9
-62
lines changed

1 file changed

+9
-62
lines changed

.github/pull_request_template.md

Lines changed: 9 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,12 @@
11
<!--
2-
Possible security vulnerabilities: STOP here and contact [email protected] instead!
3-
4-
Please update the title of the PR with a meaningful message - do not leave it "empty" or "generated"
5-
Please update this summary field:
6-
7-
The summary should cover these topics, if applicable:
8-
* the motivation for the change
9-
* a description of the status quo, for example the current behavior
10-
* the desired behavior
11-
* etc
12-
13-
PR checklist:
14-
- Do a self-review of your code before opening a pull request
15-
- Make sure that there's good test coverage for the changes included in this PR
16-
- Run tests locally before pushing a PR (./gradlew check)
17-
- Code should have comments where applicable. Particularly hard-to-understand
18-
areas deserve good in-line documentation.
19-
- Include changes and enhancements to the documentation (in site/content/in-dev/unreleased)
20-
- For Work In Progress Pull Requests, please use the Draft PR feature.
21-
22-
Make sure to add the information BELOW this comment.
23-
Everything in this comment will NOT be added to the PR description.
24-
-->
25-
26-
### What changes were proposed in this pull request?
27-
<!--
28-
Please clarify what changes you are proposing. The purpose of this section is to outline the changes and how this PR fixes the issue.
29-
If possible, please consider writing useful notes for better and faster reviews in your PR. See the examples below.
30-
1. If you refactor some codes with changing classes, showing the class hierarchy will help reviewers.
31-
2. If you fix some IRC features, you can provide some references of other IRC implementations / IRC spec.
32-
3. If there is design documentation, please add the link.
33-
4. If there is a discussion in the mailing list, please add the link.
34-
-->
35-
36-
37-
### Why are the changes needed?
38-
<!--
39-
Please clarify why the changes are needed. For instance,
40-
1. If you propose a new API, clarify the use case for a new API.
41-
2. If you fix a bug, you can clarify why it is a bug.
2+
📝 Describe what changes you're proposing, especially breaking or user-facing changes.
3+
📖 See https://github.com/apache/polaris/blob/main/CONTRIBUTING.md for more.
424
-->
435

44-
45-
### Does this PR introduce _any_ user-facing change?
46-
<!--
47-
Note that it means *any* user-facing change including all aspects such as new features, bug fixes, or other behavior changes. Documentation-only updates are not considered user-facing changes.
48-
49-
If yes, please clarify the previous behavior and the change this PR proposes - provide the console output, description and/or an example to show the behavior difference if possible.
50-
If possible, please also clarify if this is a user-facing change compared to the released Polaris versions or within the unreleased branches such as master.
51-
If no, write 'No'.
52-
-->
53-
54-
55-
### How was this patch tested?
56-
<!--
57-
If tests were added, say they were added here. Please make sure to add some test cases that check the changes thoroughly including negative and positive cases if possible.
58-
If it was tested in a way different from regular unit tests, please clarify how you tested step by step, ideally copy and paste-able, so that other reviewers can test and check, and descendants can verify in the future.
59-
If tests were not added, please describe why they were not added and/or why it was difficult to add.
60-
-->
61-
62-
### CHANGELOG.md
63-
<!--
64-
If the changes need to be included in CHANGELOG.md, please add a line here and in CHANGELOG.md.
65-
-->
6+
## Checklist
7+
- [ ] 🛡️ Don't disclose security issues! (contact [email protected])
8+
- [ ] 🔗 Clearly explained why the changes are needed, or linked related issues: Fixes #
9+
- [ ] 🧪 Added/updated tests with good coverage, or manually tested (and explained how)
10+
- [ ] 💡 Added comments for complex logic
11+
- [ ] 🧾 Updated `CHANGELOG.md` (if needed)
12+
- [ ] 📚 Updated documentation in `site/content/in-dev/unreleased` (if needed)

0 commit comments

Comments
 (0)