[arrow] branch master updated: GH-33619: [Documentation] Update PR template (#33620)

[jorisvandenbossche]

This is an automated email from the ASF dual-hosted git repository.

jorisvandenbossche pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow.git


The following commit(s) were added to refs/heads/master by this push:
     new 7e6bcd1bd7 GH-33619:  [Documentation] Update PR template (#33620)
7e6bcd1bd7 is described below

commit 7e6bcd1bd7d8b3f7da39098d80881ef4f3b1d765
Author: Jacob Wujciak-Jens <ja...@wujciak.de>
AuthorDate: Mon Jan 16 08:47:39 2023 +0100

    GH-33619:  [Documentation] Update PR template (#33620)
    
    I have switched to smaller headers for now and removed the first head + 
closes keyword to avoid redundancy.
    
    * Closes: #33619
    
    Authored-by: Jacob Wujciak-Jens <ja...@wujciak.de>
    Signed-off-by: Joris Van den Bossche <jorisvandenboss...@gmail.com>
---
 .github/pull_request_template.md | 10 ++++------
 dev/merge_arrow_pr.py            |  2 ++
 2 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index f136f8fd49..6287804545 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,4 +1,3 @@
-# Which issue does this PR close?
 
 <!--
 Thanks for opening a pull request!
@@ -25,22 +24,21 @@ In the case of PARQUET issues on JIRA the title also 
supports:
     PARQUET-${JIRA_ISSUE_ID}: [${COMPONENT}] ${SUMMARY}
 
 -->
-Closes #
 
-# Rationale for this change
+### 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?
+### 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 these changes tested?
+### Are these changes tested?
 
 <!--
 We typically require tests for all PRs in order to:
@@ -50,7 +48,7 @@ We typically require tests for all PRs in order to:
 If tests are not included in your PR, please explain why (for example, are 
they covered by existing tests)?
 -->
 
-# Are there any user-facing changes?
+### Are there any user-facing changes?
 
 <!--
 If there are user-facing changes then we may require documentation to be 
updated before approving the PR.
diff --git a/dev/merge_arrow_pr.py b/dev/merge_arrow_pr.py
index ec0ef38b7a..54729c0a52 100755
--- a/dev/merge_arrow_pr.py
+++ b/dev/merge_arrow_pr.py
@@ -575,6 +575,8 @@ class PullRequest(object):
         commit_title = f'{self.title} (#{self.number})'
         commit_message_chunks = []
         if self.body is not None:
+            # Remove comments (i.e. <-- comment -->) from the pull request 
description.
+            body = re.sub(r"<!--(.|\s)*-->", "", self.body)
             # avoid github user name references by inserting a space after @
             body = re.sub(r"@(\w+)", "@ \\1", self.body)
             commit_message_chunks.append(body)