You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by al...@apache.org on 2021/05/10 22:28:59 UTC

[arrow-datafusion] 01/01: Update PR template by commenting out instructions

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

alamb pushed a commit to branch alamb-patch-1
in repository https://gitbox.apache.org/repos/asf/arrow-datafusion.git

commit b975258101701b0cdb472097d84c2a7a538555d4
Author: Andrew Lamb <an...@nerdnetworks.org>
AuthorDate: Mon May 10 18:28:52 2021 -0400

    Update PR template by commenting out instructions
    
    Inspired by @nevi-me 's PR https://github.com/apache/arrow-rs/pull/278
    
    Some contributors don't remove the guidelines when creating PRs, so it might be more convenient if we hide them behind comments.
    The comments are still visible when editing, but are not displayed when the markdown is rendered
---
 .github/pull_request_template.md | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 5da0d08..3e887f9 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,19 +1,25 @@
 # 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 add the `breaking change` label.
+-->