This is an automated email from the ASF dual-hosted git repository.
alamb pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-rs.git
The following commit(s) were added to refs/heads/main by this push:
new 8a77bcebb3 Improve the PR template for usable as commit message (#7586)
8a77bcebb3 is described below
commit 8a77bcebb3f48fd5153a1d7e2205c7c01e7dae57
Author: Sutou Kouhei <[email protected]>
AuthorDate: Mon Jun 2 21:33:38 2025 +0900
Improve the PR template for usable as commit message (#7586)
# Which issue does this PR close?
Closes #7581.
# Rationale for this change
If we keep using the current pull request template, we may close
unrelated #123 accidentally again.
# What changes are included in this PR?
* Don't use #123 as example in comment
* Use raw text instead of comment to describe contents
# Are there any user-facing changes?
No.
---
.github/pull_request_template.md | 17 +++--------------
1 file changed, 3 insertions(+), 14 deletions(-)
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index b275cf64af..e999f505bc 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,31 +1,20 @@
# Which issue does this PR close?
-<!--
-We generally require a GitHub issue to be filed for all bug fixes and
enhancements and this helps us generate change logs for our releases. You can
link an issue to this PR using the GitHub syntax. For example `Closes #123`
indicates that this PR will close issue #123.
--->
+We generally require a GitHub issue to be filed for all bug fixes and
enhancements and this helps us generate change logs for our releases. You can
link an issue to this PR using the GitHub syntax.
-Closes #.
+Closes #NNN.
# Rationale for this change
-
-<!--
+
Why are you proposing this change? If this is already explained clearly in the
issue then this section is not needed.
Explaining clearly why changes are proposed helps reviewers understand your
changes and offer better suggestions for fixes.
--->
# What changes are included in this PR?
-<!--
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.
--->
# Are there any user-facing changes?
-
-<!--
If there are user-facing changes then we may require documentation to be
updated before approving the PR.
--->
-<!---
If there are any breaking changes to public APIs, please call them out.
--->
