Improve the PR template for usable as commit message

[kou]

Is your feature request related to a problem or challenge? Please describe what you are trying to do.

#7563 changed to use the PR title and description (as the default value) of a merged squashed commit.

Our PR template includes Closes #123 as an example in comment. So if a PR doesn't remove the comment in our PR template, #123 is closed automatically.

Example: 28c3cb9 / #7535

Describe the solution you'd like

Don't use comment in our PR template.

FYI:

• apache/arrow uses this approach: GH-45485: [Dev] Simplify pull request template arrow#45599 / [Dev] How about removing explanation as comment in pull request template? arrow#45485
  • apache/arrow removes comments in sections and uses a top description as a normal text (not a comment)
• apache/arrow-go uses this approach: GH-23: Add PR template arrow-go#164

Describe alternatives you've considered

Remove the Close #123 example.

Additional context

None.

[kou]

A raw text approach example:

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index b275cf64a..2af199cec 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,31 +1,21 @@
 # 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.
--->
 
 Closes #.
 
 # 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.
--->

[kou]

An example that removes Closes #123:

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index b275cf64a..720ba8724 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,10 +1,10 @@
 # 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
  

[kou]

apache/arrow like approach example:

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index b275cf64a..0b1106160 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,31 +1,20 @@
-# Which issue does this PR close?
+Thanks for opening a pull request!
+
+If this is your first pull request you can find detailed information on how to contribute in [CONTRIBUGING.md](https://github.com/apache/arrow-rs/blob/main/CONTRIBUTING.md).
 
-<!--
-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.
--->
+Please remove this line and the above text before creating your pull request.
+
+# Which issue does this PR close?
 
-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.
--->
+# What changes are included 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.
--->

[kou]

Which approach do you prefer?

[alamb]

Thanks @kou -- I prefer a combination of

• "Raw text approach"
• An example that removes Closes Read/write data in respect to endianness #123:

I think that is a minimal change and avoids the issues you have found.

[kou]

OK. How about #7586?