Skip to content

Commit 12cdaaa

Browse files
authored
GH-45485: [Dev] Simplify pull request template (#45599)
### Rationale for this change It seems that the current comment based pull request template isn't read carefully. ### What changes are included in this PR? * Remove explanations as comments * Keep a basic introduction in the top as a normal text not a comment * Use normal texts not comments for breaking changes and critical fix ### Are these changes tested? No. ### Are there any user-facing changes? No. This is only for developers. * GitHub Issue: #45485 Authored-by: Sutou Kouhei <[email protected]> Signed-off-by: Raúl Cumplido <[email protected]>
1 parent b36659a commit 12cdaaa

File tree

1 file changed

+6
-47
lines changed

1 file changed

+6
-47
lines changed

.github/pull_request_template.md

Lines changed: 6 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,20 @@
1-
2-
<!--
31
Thanks for opening a pull request!
4-
If this is your first pull request you can find detailed information on how
5-
to contribute here:
6-
* [New Contributor's Guide](https://arrow.apache.org/docs/dev/developers/guide/step_by_step/pr_lifecycle.html#reviews-and-merge-of-the-pull-request)
7-
* [Contributing Overview](https://arrow.apache.org/docs/dev/developers/overview.html)
8-
9-
10-
If this is not a [minor PR](https://github.com/apache/arrow/blob/main/CONTRIBUTING.md#Minor-Fixes). Could you open an issue for this pull request on GitHub? https://github.com/apache/arrow/issues/new/choose
11-
12-
Opening GitHub issues ahead of time contributes to the [Openness](http://theapacheway.com/open/#:~:text=Openness%20allows%20new%20users%20the,must%20happen%20in%20the%20open.) of the Apache Arrow project.
13-
14-
Then could you also rename the pull request title in the following format?
15-
16-
GH-${GITHUB_ISSUE_ID}: [${COMPONENT}] ${SUMMARY}
172

18-
or
3+
If this is your first pull request you can find detailed information on how to contribute here:
194

20-
MINOR: [${COMPONENT}] ${SUMMARY}
5+
* [New Contributor's Guide](https://arrow.apache.org/docs/dev/developers/guide/step_by_step/pr_lifecycle.html#reviews-and-merge-of-the-pull-request)
6+
* [Contributing Overview](https://arrow.apache.org/docs/dev/developers/overview.html)
217

22-
-->
8+
Please remove this line and the above text before creating your pull request.
239

2410
### Rationale for this change
2511

26-
<!--
27-
Why are you proposing this change? If this is already explained clearly in the issue then this section is not needed.
28-
Explaining clearly why changes are proposed helps reviewers understand your changes and offer better suggestions for fixes.
29-
-->
30-
3112
### What changes are included in this PR?
3213

33-
<!--
34-
There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes in this PR.
35-
-->
36-
3714
### Are these changes tested?
3815

39-
<!--
40-
We typically require tests for all PRs in order to:
41-
1. Prevent the code from being accidentally broken by subsequent changes
42-
2. Serve as another way to document the expected behavior of the code
43-
44-
If tests are not included in your PR, please explain why (for example, are they covered by existing tests)?
45-
-->
46-
4716
### Are there any user-facing changes?
4817

49-
<!--
50-
If there are user-facing changes then we may require documentation to be updated before approving the PR.
51-
-->
52-
53-
<!--
54-
If there are any breaking changes to public APIs, please uncomment the line below and explain which changes are breaking.
55-
-->
56-
<!-- **This PR includes breaking changes to public APIs.** -->
18+
**This PR includes breaking changes to public APIs.** (If there are any breaking changes to public APIs, please explain which changes are breaking. If not, you can remove this.)
5719

58-
<!--
59-
Please uncomment the line below (and provide explanation) if the changes fix either (a) a security vulnerability, (b) a bug that caused incorrect or invalid data to be produced, or (c) a bug that causes a crash (even when the API contract is upheld). We use this to highlight fixes to issues that may affect users without their knowledge. For this reason, fixing bugs that cause errors don't count, since those are usually obvious.
60-
-->
61-
<!-- **This PR contains a "Critical Fix".** -->
20+
**This PR contains a "Critical Fix".** (If the changes fix either (a) a security vulnerability, (b) a bug that caused incorrect or invalid data to be produced, or (c) a bug that causes a crash (even when the API contract is upheld), please provide explanation. If not, you can remove this.)

0 commit comments

Comments
 (0)