From b975258101701b0cdb472097d84c2a7a538555d4 Mon Sep 17 00:00:00 2001 From: Andrew Lamb Date: Mon, 10 May 2021 18:28:52 -0400 Subject: [PATCH 1/2] 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 5da0d08f9469..3e887f970061 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,19 +1,25 @@ # Which issue does this PR close? + Closes #. # Rationale for this change + # 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 add the `breaking change` label. +--> From 2060dfe8f7c088c255c4fb8d431fdee9cc450666 Mon Sep 17 00:00:00 2001 From: Andrew Lamb Date: Tue, 11 May 2021 05:53:22 -0400 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Wakahisa --- .github/pull_request_template.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 3e887f970061..e32246061f81 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -18,8 +18,10 @@ There is no need to duplicate the description in the issue here but it is someti --> # Are there any user-facing changes? -<-- + +