Update PR template by commenting out instructions (#315)

* Update PR template by commenting out instructions Inspired by @nevi-me 's PR apache/arrow-rs#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 * Apply suggestions from code review Co-authored-by: Wakahisa <[email protected]> Co-authored-by: Wakahisa <[email protected]>
apache · May 11, 2021 · 63eaeee · 63eaeee
1 parent 7133c33
commit 63eaeee
Showing 1 changed file with 10 additions and 2 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,19 +1,27 @@
 # 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.
+-->