Re: [PR PATCH] [Updated] [RFC]: .github: improve the PR template

[paper42 <paper42@users.noreply.github.com>]

[-- Attachment #1: Type: text/plain, Size: 547 bytes --]

There is an updated pull request by paper42 against master on the void-packages repository

https://github.com/paper42/void-packages pr-template-clarify
https://github.com/void-linux/void-packages/pull/33118

[RFC]: .github: improve the PR template
Filling out the "Does it run and build successfully" section is
necessary only when the CI is skipped, but this is easy to miss.
Separate it from the rest of the text to make it clearer.

cc @ailiop-git

A patch file from https://github.com/void-linux/void-packages/pull/33118.patch is attached

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-pr-template-clarify-33118.patch --]
[-- Type: text/x-diff, Size: 3164 bytes --]

From 95243404fdf33874305b99b17409b34c174cc57e Mon Sep 17 00:00:00 2001
From: Michal Vasilek <michal@vasilek.cz>
Date: Sat, 25 Sep 2021 14:56:06 +0200
Subject: [PATCH] .github: improve the PR template

* switch from using checkboxes to deleting the lines which are not
  applicable
* make it clear that filling out the part about manual builds is only
  necessary when the CI is skipped, this was easy to miss
---
 .github/pull_request_template.md | 39 ++++++++++++++++----------------
 1 file changed, 19 insertions(+), 20 deletions(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 1fdf9e94ea93..5b1ca3b31cb5 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,26 +1,25 @@
-<!-- Mark items with [x] where applicable -->
+<!-- Uncomment relevant sections and delete the lines which are not applicable -->
 
-#### General
-- [ ] This is a new package and it conforms to the [quality requirements](https://github.com/void-linux/void-packages/blob/master/Manual.md#quality-requirements)
-
-#### Have the results of the proposed changes been tested?
-- [ ] I use the packages affected by the proposed changes on a regular basis and confirm this PR works for me
-- [ ] I generally don't use the affected packages but briefly tested this PR
+<!-- Note: PRs should only have one entry in the following section, otherwise
+it will be assumed they have not been tested at all. -->
+#### Testing the changes
+- I use the packages affected by the proposed changes on a regular basis and confirm this PR works for me
+- I generally don't use the affected packages but briefly tested this PR
 
 <!--
-If GitHub CI cannot be used to validate the build result (for example, if the
-build is likely to take several hours), make sure to
-[skip CI](https://github.com/void-linux/void-packages/blob/master/CONTRIBUTING.md#continuous-integration).
-When skipping CI, uncomment and fill out the following section.
-Note: for builds that are likely to complete in less than 2 hours, it is not
-acceptable to skip CI.
+#### New package
+- This new package conforms to the [quality requirements](https://github.com/void-linux/void-packages/blob/master/Manual.md#quality-requirements)
+-->
+
+<!-- Note: If the build is likely to take more than 2 hours, please [skip CI](https://github.com/void-linux/void-packages/blob/master/CONTRIBUTING.md#continuous-integration)
+and test at least one native build and, if supported, at least one cross build.
+Ignore this section if this PR is not skipping CI.
 -->
 <!-- 
-#### Does it build and run successfully? 
-(Please choose at least one native build and, if supported, at least one cross build. More are better.)
-- [ ] I built this PR locally for my native architecture, (ARCH-LIBC)
-- [ ] I built this PR locally for these architectures (if supported. mark crossbuilds):
-  - [ ] aarch64-musl
-  - [ ] armv7l
-  - [ ] armv6l-musl
+#### Local build testing
+- I built this PR locally for my native architecture, (ARCH-LIBC)
+- I built this PR locally for these architectures (if supported. mark crossbuilds):
+  - aarch64-musl
+  - armv7l
+  - armv6l-musl
 -->