Github messages for voidlinux
 help / color / mirror / Atom feed
* [PR PATCH] .github: clarify the PR template
@ 2021-09-25 14:42 paper42
  2021-09-25 18:06 ` ericonr
                   ` (21 more replies)
  0 siblings, 22 replies; 23+ messages in thread
From: paper42 @ 2021-09-25 14:42 UTC (permalink / raw)
  To: ml

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

There is a new 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

.github: clarify 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: 1231 bytes --]

From ee5d9f0f8e61af3ddf04ec89ae5f8ecab6cd4096 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: clarify 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.
---
 .github/pull_request_template.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 1fdf9e94ea93..fb7b26eb1e27 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -11,9 +11,10 @@
 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.
+
+When skipping CI, uncomment and fill out the following section.
 -->
 <!-- 
 #### Does it build and run successfully? 

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: .github: clarify the PR template
  2021-09-25 14:42 [PR PATCH] .github: clarify the PR template paper42
@ 2021-09-25 18:06 ` ericonr
  2021-09-25 22:03 ` [PR PATCH] [Updated] " paper42
                   ` (20 subsequent siblings)
  21 siblings, 0 replies; 23+ messages in thread
From: ericonr @ 2021-09-25 18:06 UTC (permalink / raw)
  To: ml

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

New comment by ericonr on void-packages repository

https://github.com/void-linux/void-packages/pull/33118#issuecomment-927160872

Comment:
Want to couple this with not making them tick boxes anymore? Having all PRs with checklists is a bit bothersome.

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [PR PATCH] [Updated] .github: clarify the PR template
  2021-09-25 14:42 [PR PATCH] .github: clarify the PR template paper42
  2021-09-25 18:06 ` ericonr
@ 2021-09-25 22:03 ` paper42
  2021-09-25 22:08 ` [RFC]: .github: improve " paper42
                   ` (19 subsequent siblings)
  21 siblings, 0 replies; 23+ messages in thread
From: paper42 @ 2021-09-25 22:03 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 540 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

.github: clarify 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: 3093 bytes --]

From 83d841718b016585e1d488568326e658dfb2dae2 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 since this was easy to miss
---
 .github/pull_request_template.md | 33 +++++++++++++++++---------------
 1 file changed, 18 insertions(+), 15 deletions(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 1fdf9e94ea93..a254c8c6fb6b 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,26 +1,29 @@
-<!-- Mark items with [x] where 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)
+<!-- Uncomment relevant sections and delete the lines which are not applicable -->
+<!--
+## New package
+- This new package conforms to the [quality requirements](https://github.com/void-linux/void-packages/blob/master/Manual.md#quality-requirements)
+- This new package doesn't conform to the [quality requirements](https://github.com/void-linux/void-packages/blob/master/Manual.md#quality-requirements), but I believe an exception should be made because xxx
+-->
 
-#### 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
+## 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.
+
+Ignore the following section if this PR doesn't skip 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
+(Please test 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
 -->

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [RFC]: .github: improve the PR template
  2021-09-25 14:42 [PR PATCH] .github: clarify the PR template paper42
  2021-09-25 18:06 ` ericonr
  2021-09-25 22:03 ` [PR PATCH] [Updated] " paper42
@ 2021-09-25 22:08 ` paper42
  2021-09-27 20:45 ` [PR REVIEW] " Chocimier
                   ` (18 subsequent siblings)
  21 siblings, 0 replies; 23+ messages in thread
From: paper42 @ 2021-09-25 22:08 UTC (permalink / raw)
  To: ml

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

New comment by paper42 on void-packages repository

https://github.com/void-linux/void-packages/pull/33118#issuecomment-927189123

Comment:
> Want to couple this with not making them tick boxes anymore? Having all PRs with checklists is a bit bothersome.

I made a draft of how it could look. It needs a grammar review and we also need to decide if this is the right way to go. @void-linux/pkg-committers

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [PR REVIEW] [RFC]: .github: improve the PR template
  2021-09-25 14:42 [PR PATCH] .github: clarify the PR template paper42
                   ` (2 preceding siblings ...)
  2021-09-25 22:08 ` [RFC]: .github: improve " paper42
@ 2021-09-27 20:45 ` Chocimier
  2021-09-27 20:45 ` Chocimier
                   ` (17 subsequent siblings)
  21 siblings, 0 replies; 23+ messages in thread
From: Chocimier @ 2021-09-27 20:45 UTC (permalink / raw)
  To: ml

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

New review comment by Chocimier on void-packages repository

https://github.com/void-linux/void-packages/pull/33118#discussion_r717030271

Comment:
Whole section could be shortened to something like

> Build takes over 2h so I build locally for following archs, and am \[ci skipping]()

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [PR REVIEW] [RFC]: .github: improve the PR template
  2021-09-25 14:42 [PR PATCH] .github: clarify the PR template paper42
                   ` (3 preceding siblings ...)
  2021-09-27 20:45 ` [PR REVIEW] " Chocimier
@ 2021-09-27 20:45 ` Chocimier
  2021-09-28 20:02 ` Piraty
                   ` (16 subsequent siblings)
  21 siblings, 0 replies; 23+ messages in thread
From: Chocimier @ 2021-09-27 20:45 UTC (permalink / raw)
  To: ml

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

New review comment by Chocimier on void-packages repository

https://github.com/void-linux/void-packages/pull/33118#discussion_r717028697

Comment:
More often used _Testing the changes_ could go first.

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [RFC]: .github: improve the PR template
  2021-09-25 14:42 [PR PATCH] .github: clarify the PR template paper42
                   ` (4 preceding siblings ...)
  2021-09-27 20:45 ` Chocimier
@ 2021-09-28 20:02 ` Piraty
  2021-09-29  7:23 ` [PR PATCH] [Updated] " paper42
                   ` (15 subsequent siblings)
  21 siblings, 0 replies; 23+ messages in thread
From: Piraty @ 2021-09-28 20:02 UTC (permalink / raw)
  To: ml

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

New comment by Piraty on void-packages repository

https://github.com/void-linux/void-packages/pull/33118#issuecomment-929581868

Comment:
some of the usual suspects already miss the point of why this was added in the first place, i'm all for cleaning it up

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [PR PATCH] [Updated] [RFC]: .github: improve the PR template
  2021-09-25 14:42 [PR PATCH] .github: clarify the PR template paper42
                   ` (5 preceding siblings ...)
  2021-09-28 20:02 ` Piraty
@ 2021-09-29  7:23 ` paper42
  2021-09-29  7:25 ` [PR REVIEW] " paper42
                   ` (14 subsequent siblings)
  21 siblings, 0 replies; 23+ messages in thread
From: paper42 @ 2021-09-29  7:23 UTC (permalink / raw)
  To: ml

[-- 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: 3308 bytes --]

From a396af6794b6499e9ba4a400a4bc8368cb130689 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 since this was easy to miss
---
 .github/pull_request_template.md | 41 ++++++++++++++++----------------
 1 file changed, 21 insertions(+), 20 deletions(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 1fdf9e94ea93..77d2440d4a6d 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,26 +1,27 @@
-<!-- Mark items with [x] where applicable -->
+<!-- Uncomment relevant sections and delete the lines which are not applicable -->
+## 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
 
-#### 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
+<!--
+## New package
+- This new package conforms to the [quality requirements](https://github.com/void-linux/void-packages/blob/master/Manual.md#quality-requirements)
+- This new package doesn't conform to the [quality requirements](https://github.com/void-linux/void-packages/blob/master/Manual.md#quality-requirements), but I believe an exception should be made because ...
+-->
 
 <!--
-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.
+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)
+and fill out the following section.
+
+Ignore the following section if this pull request doesn't skip 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
+(Please test 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
 -->

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [PR REVIEW] [RFC]: .github: improve the PR template
  2021-09-25 14:42 [PR PATCH] .github: clarify the PR template paper42
                   ` (6 preceding siblings ...)
  2021-09-29  7:23 ` [PR PATCH] [Updated] " paper42
@ 2021-09-29  7:25 ` paper42
  2021-10-03 21:52 ` [PR PATCH] [Updated] " paper42
                   ` (13 subsequent siblings)
  21 siblings, 0 replies; 23+ messages in thread
From: paper42 @ 2021-09-29  7:25 UTC (permalink / raw)
  To: ml

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

New review comment by paper42 on void-packages repository

https://github.com/void-linux/void-packages/pull/33118#discussion_r718225901

Comment:
I shortened it a bit, but it's still long.

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [PR PATCH] [Updated] [RFC]: .github: improve the PR template
  2021-09-25 14:42 [PR PATCH] .github: clarify the PR template paper42
                   ` (7 preceding siblings ...)
  2021-09-29  7:25 ` [PR REVIEW] " paper42
@ 2021-10-03 21:52 ` paper42
  2021-10-03 21:56 ` [PR REVIEW] " paper42
                   ` (12 subsequent siblings)
  21 siblings, 0 replies; 23+ messages in thread
From: paper42 @ 2021-10-03 21:52 UTC (permalink / raw)
  To: ml

[-- 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
 -->

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [PR REVIEW] [RFC]: .github: improve the PR template
  2021-09-25 14:42 [PR PATCH] .github: clarify the PR template paper42
                   ` (8 preceding siblings ...)
  2021-10-03 21:52 ` [PR PATCH] [Updated] " paper42
@ 2021-10-03 21:56 ` paper42
  2021-10-04 16:04 ` Chocimier
                   ` (11 subsequent siblings)
  21 siblings, 0 replies; 23+ messages in thread
From: paper42 @ 2021-10-03 21:56 UTC (permalink / raw)
  To: ml

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

New review comment by paper42 on void-packages repository

https://github.com/void-linux/void-packages/pull/33118#discussion_r720912899

Comment:
Is this fine or is it too harsh?

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [PR REVIEW] [RFC]: .github: improve the PR template
  2021-09-25 14:42 [PR PATCH] .github: clarify the PR template paper42
                   ` (9 preceding siblings ...)
  2021-10-03 21:56 ` [PR REVIEW] " paper42
@ 2021-10-04 16:04 ` Chocimier
  2021-10-05 19:17 ` Piraty
                   ` (10 subsequent siblings)
  21 siblings, 0 replies; 23+ messages in thread
From: Chocimier @ 2021-10-04 16:04 UTC (permalink / raw)
  To: ml

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

New review comment by Chocimier on void-packages repository

https://github.com/void-linux/void-packages/pull/33118#discussion_r721507234

Comment:
Policy is just right, statement is kind of implied by previous one.

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [PR REVIEW] [RFC]: .github: improve the PR template
  2021-09-25 14:42 [PR PATCH] .github: clarify the PR template paper42
                   ` (10 preceding siblings ...)
  2021-10-04 16:04 ` Chocimier
@ 2021-10-05 19:17 ` Piraty
  2021-10-14 16:32 ` Chocimier
                   ` (9 subsequent siblings)
  21 siblings, 0 replies; 23+ messages in thread
From: Piraty @ 2021-10-05 19:17 UTC (permalink / raw)
  To: ml

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

New review comment by Piraty on void-packages repository

https://github.com/void-linux/void-packages/pull/33118#discussion_r722566755

Comment:
not harsh and to the point.

how about something like `*YES*|*NO*` (in bolds) to make it both (even more) obvious to contributor that an answer is required and obvious to maintainer if it wasn't answered (like not checking any checkbox before).

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [PR REVIEW] [RFC]: .github: improve the PR template
  2021-09-25 14:42 [PR PATCH] .github: clarify the PR template paper42
                   ` (11 preceding siblings ...)
  2021-10-05 19:17 ` Piraty
@ 2021-10-14 16:32 ` Chocimier
  2021-10-22 23:06 ` paper42
                   ` (8 subsequent siblings)
  21 siblings, 0 replies; 23+ messages in thread
From: Chocimier @ 2021-10-14 16:32 UTC (permalink / raw)
  To: ml

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

New review comment by Chocimier on void-packages repository

https://github.com/void-linux/void-packages/pull/33118#discussion_r729154246

Comment:
good idea of yes|no

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [PR REVIEW] [RFC]: .github: improve the PR template
  2021-09-25 14:42 [PR PATCH] .github: clarify the PR template paper42
                   ` (12 preceding siblings ...)
  2021-10-14 16:32 ` Chocimier
@ 2021-10-22 23:06 ` paper42
  2021-10-23 10:47 ` Gottox
                   ` (7 subsequent siblings)
  21 siblings, 0 replies; 23+ messages in thread
From: paper42 @ 2021-10-22 23:06 UTC (permalink / raw)
  To: ml

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

New review comment by paper42 on void-packages repository

https://github.com/void-linux/void-packages/pull/33118#discussion_r734883407

Comment:
> Policy is just right, statement is kind of implied by previous one.
> not harsh and to the point.

I think I will leave it there even though it's implied by the first comment just to be explicit.

> how about something like *YES*|*NO* (in bolds) to make it both (even more) obvious to contributor that an answer is required and obvious to maintainer if it wasn't answered (like not checking any checkbox before).

Something like this?
```
#### Testing the changes
- I confirm this PR works for me: **YES**|**briefly**|**NO**

#### New package
- This new package conforms to the quality requirements: **YES**|**NO**

#### 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
```

This way we can not differentiate between well tested and lightly tested PRs. The last section can not be adapted to this form, so it will be inconsistent with the rest of the PR template.


^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [PR REVIEW] [RFC]: .github: improve the PR template
  2021-09-25 14:42 [PR PATCH] .github: clarify the PR template paper42
                   ` (13 preceding siblings ...)
  2021-10-22 23:06 ` paper42
@ 2021-10-23 10:47 ` Gottox
  2021-10-24 17:25 ` [PR PATCH] [Updated] " paper42
                   ` (6 subsequent siblings)
  21 siblings, 0 replies; 23+ messages in thread
From: Gottox @ 2021-10-23 10:47 UTC (permalink / raw)
  To: ml

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

New review comment by Gottox on void-packages repository

https://github.com/void-linux/void-packages/pull/33118#discussion_r734955663

Comment:
Looks good to me.
* Maybe link the quality requirements, so new committers can find them
* Give committers instructions when it's okay to remove a statement and which are mandatory to open a PR.

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [PR PATCH] [Updated] [RFC]: .github: improve the PR template
  2021-09-25 14:42 [PR PATCH] .github: clarify the PR template paper42
                   ` (14 preceding siblings ...)
  2021-10-23 10:47 ` Gottox
@ 2021-10-24 17:25 ` paper42
  2021-10-25 17:42 ` [PR REVIEW] " Chocimier
                   ` (5 subsequent siblings)
  21 siblings, 0 replies; 23+ messages in thread
From: paper42 @ 2021-10-24 17:25 UTC (permalink / raw)
  To: ml

[-- 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: 2900 bytes --]

From 2b33326cb51e4bad1d9fe23459b227deb0078586 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 **YES**|**NO** options
* 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 | 36 ++++++++++++++------------------
 1 file changed, 16 insertions(+), 20 deletions(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 1fdf9e94ea93..cc4b5721590e 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,26 +1,22 @@
-<!-- Mark items with [x] where applicable -->
+<!-- Uncomment relevant sections and delete options 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
+#### Testing the changes
+- I tested the changes in this PR: **YES**|**briefly**|**NO**
 
 <!--
-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): **YES**|**NO**
+-->
+
+<!-- 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
 -->

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [PR REVIEW] [RFC]: .github: improve the PR template
  2021-09-25 14:42 [PR PATCH] .github: clarify the PR template paper42
                   ` (15 preceding siblings ...)
  2021-10-24 17:25 ` [PR PATCH] [Updated] " paper42
@ 2021-10-25 17:42 ` Chocimier
  2021-10-28 22:03 ` paper42
                   ` (4 subsequent siblings)
  21 siblings, 0 replies; 23+ messages in thread
From: Chocimier @ 2021-10-25 17:42 UTC (permalink / raw)
  To: ml

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

New review comment by Chocimier on void-packages repository

https://github.com/void-linux/void-packages/pull/33118#discussion_r735824340

Comment:
Second thought: separate lines are easier to edit, thus better for permanent contributors.
Could that be changed to something keyboard-friendly like `** YES briefly NO **`, at least?

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [PR REVIEW] [RFC]: .github: improve the PR template
  2021-09-25 14:42 [PR PATCH] .github: clarify the PR template paper42
                   ` (16 preceding siblings ...)
  2021-10-25 17:42 ` [PR REVIEW] " Chocimier
@ 2021-10-28 22:03 ` paper42
  2021-10-29 15:28 ` Chocimier
                   ` (3 subsequent siblings)
  21 siblings, 0 replies; 23+ messages in thread
From: paper42 @ 2021-10-28 22:03 UTC (permalink / raw)
  To: ml

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

New review comment by paper42 on void-packages repository

https://github.com/void-linux/void-packages/pull/33118#discussion_r738805970

Comment:
Removing lines has an unfortunate consequence - it's not immediately obvious which option was selected compared to the current way (checkboxes). This might make PR template useless if we don't figure out how to clearly distinguish the options - different words at the start, different length, etc.

I would be in favor of the YES NO way because it's clear where to look when reviewing a PR.

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [PR REVIEW] [RFC]: .github: improve the PR template
  2021-09-25 14:42 [PR PATCH] .github: clarify the PR template paper42
                   ` (17 preceding siblings ...)
  2021-10-28 22:03 ` paper42
@ 2021-10-29 15:28 ` Chocimier
  2021-11-08 22:32 ` Piraty
                   ` (2 subsequent siblings)
  21 siblings, 0 replies; 23+ messages in thread
From: Chocimier @ 2021-10-29 15:28 UTC (permalink / raw)
  To: ml

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

New review comment by Chocimier on void-packages repository

https://github.com/void-linux/void-packages/pull/33118#discussion_r739330443

Comment:
Let's try to distinguish, with decoupling "tested" from "using" on top.

    #### Testing the changes
    - I regularly use the affected package
    - Just contributing with package I use sporadically to never

    - I tested the changes in this PR by using package with changes for some time
    - Automated `do_check` passed, nothing can possibly go wrong

    #### New package
    - This new package conforms to the [quality requirements](https://github.com/void-linux/void-packages/blob/master/Manual.md#quality-requirements)
    - Excuse to not conform to the quality requirements is ...


^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [RFC]: .github: improve the PR template
  2021-09-25 14:42 [PR PATCH] .github: clarify the PR template paper42
                   ` (18 preceding siblings ...)
  2021-10-29 15:28 ` Chocimier
@ 2021-11-08 22:32 ` Piraty
  2021-11-08 23:02 ` Vaelatern
  2021-11-09 23:31 ` [PR PATCH] [Merged]: " Piraty
  21 siblings, 0 replies; 23+ messages in thread
From: Piraty @ 2021-11-08 22:32 UTC (permalink / raw)
  To: ml

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

New comment by Piraty on void-packages repository

https://github.com/void-linux/void-packages/pull/33118#issuecomment-963635486

Comment:
fine, everyone?

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [RFC]: .github: improve the PR template
  2021-09-25 14:42 [PR PATCH] .github: clarify the PR template paper42
                   ` (19 preceding siblings ...)
  2021-11-08 22:32 ` Piraty
@ 2021-11-08 23:02 ` Vaelatern
  2021-11-09 23:31 ` [PR PATCH] [Merged]: " Piraty
  21 siblings, 0 replies; 23+ messages in thread
From: Vaelatern @ 2021-11-08 23:02 UTC (permalink / raw)
  To: ml

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

New comment by Vaelatern on void-packages repository

https://github.com/void-linux/void-packages/pull/33118#issuecomment-963651508

Comment:
:shipit: 

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [PR PATCH] [Merged]: [RFC]: .github: improve the PR template
  2021-09-25 14:42 [PR PATCH] .github: clarify the PR template paper42
                   ` (20 preceding siblings ...)
  2021-11-08 23:02 ` Vaelatern
@ 2021-11-09 23:31 ` Piraty
  21 siblings, 0 replies; 23+ messages in thread
From: Piraty @ 2021-11-09 23:31 UTC (permalink / raw)
  To: ml

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

There's a merged pull request on the void-packages repository

[RFC]: .github: improve the PR template
https://github.com/void-linux/void-packages/pull/33118

Description:
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

^ permalink raw reply	[flat|nested] 23+ messages in thread

end of thread, other threads:[~2021-11-09 23:31 UTC | newest]

Thread overview: 23+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-09-25 14:42 [PR PATCH] .github: clarify the PR template paper42
2021-09-25 18:06 ` ericonr
2021-09-25 22:03 ` [PR PATCH] [Updated] " paper42
2021-09-25 22:08 ` [RFC]: .github: improve " paper42
2021-09-27 20:45 ` [PR REVIEW] " Chocimier
2021-09-27 20:45 ` Chocimier
2021-09-28 20:02 ` Piraty
2021-09-29  7:23 ` [PR PATCH] [Updated] " paper42
2021-09-29  7:25 ` [PR REVIEW] " paper42
2021-10-03 21:52 ` [PR PATCH] [Updated] " paper42
2021-10-03 21:56 ` [PR REVIEW] " paper42
2021-10-04 16:04 ` Chocimier
2021-10-05 19:17 ` Piraty
2021-10-14 16:32 ` Chocimier
2021-10-22 23:06 ` paper42
2021-10-23 10:47 ` Gottox
2021-10-24 17:25 ` [PR PATCH] [Updated] " paper42
2021-10-25 17:42 ` [PR REVIEW] " Chocimier
2021-10-28 22:03 ` paper42
2021-10-29 15:28 ` Chocimier
2021-11-08 22:32 ` Piraty
2021-11-08 23:02 ` Vaelatern
2021-11-09 23:31 ` [PR PATCH] [Merged]: " Piraty

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).