[PR PATCH] CONTRIBUTING.md: be clearer about "one commit per PR" rule.

[PR PATCH] CONTRIBUTING.md: be clearer about "one commit per PR" rule.

[ericonr]

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

There is a new pull request by ericonr against master on the void-packages repository

https://github.com/ericonr/void-packages contr
https://github.com/void-linux/void-packages/pull/29568

CONTRIBUTING.md: be clearer about "one commit per PR" rule.


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

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

From b870cf1533d8f0e19f6c8e5d909dcff5df42dc33 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=89rico=20Nogueira?= <erico.erc@gmail.com>
Date: Thu, 18 Mar 2021 14:29:32 -0300
Subject: [PATCH] CONTRIBUTING.md: be clearer about "one commit per PR" rule.

---
 CONTRIBUTING.md | 9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 4cadfc6265b7..38a0f7826402 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -74,7 +74,7 @@ New packages will not be accepted unless they have been runtime tested.
 
 ### Starting a pull request
 
-Once you have successfully built the package, you can [create a pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).
+Once you have successfully built the package, you can [create a pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request). Pull requests are also known as PRs.
 
 Most pull requests should only contain a single package and dependencies which are not part of void-packages yet.
 
@@ -99,11 +99,10 @@ comply with the our guidelines. At the moment not all packages comply with the r
 
 #### Review
 
-Most of the time your pull request will contain mistakes. It's nothing bad, it just happens.
+It's possible (and common) that a pull request will contain mistakes or reviewers will ask for additional tweaks.
+Reviewers will comment on your pull request and point out which changes are needed before the pull request can be merged.
 
-Reviewers will comment on your pull request and point out which changes are needed before the template can be included.
-
-We recommend having only a single commit for pull request, so if you need to make changes in commits but already have a pull request, use the following commands:
+Most PRs will have a single commit, as seen [above](#starting-a-pull-request), so if you need to make changes to the commit but already have a pull request, use the following commands:
 
     $ git add <file>
     $ git commit --amend

Re: [PR REVIEW] CONTRIBUTING.md: be clearer about "one commit per PR" rule.

[Chocimier]

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

New review comment by Chocimier on void-packages repository

https://github.com/void-linux/void-packages/pull/29568#discussion_r597136280

Comment:
Thanks, I wanted link that recently an coudn't because of "single commit for pull request". How would you like [one more change](https://github.com/Chocimier/void-packages-org/commit/2e6b32a56f7d134484d37f902f0533bca3eb9f2f) in "Committing your changes" and linking there from here?

Re: [PR PATCH] [Updated] CONTRIBUTING.md: be clearer about "one commit per PR" rule.

[ericonr]

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

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

https://github.com/ericonr/void-packages contr
https://github.com/void-linux/void-packages/pull/29568

CONTRIBUTING.md: be clearer about "one commit per PR" rule.


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

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

From 1ac06f230019d0c6b44d2b6eed70573d79ad5e80 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=89rico=20Nogueira?= <erico.erc@gmail.com>
Date: Thu, 18 Mar 2021 14:29:32 -0300
Subject: [PATCH] CONTRIBUTING.md: be clearer about "one commit per PR" rule.

---
 CONTRIBUTING.md | 11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 4cadfc6265b7..a312efaeb213 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -41,7 +41,7 @@ If `xlint` reports any issues, resolve them before committing.
 
 ### Committing your changes
 
-Once you have built your template file or files, the commit message should have one of the following forms:
+Once you have made and verified your changes to the package template and/or other files, make one commit per package. Each commit message should have one of the following formats:
 
 * for new packages, use ```New package: <pkgname>-<version>``` ([example](https://github.com/void-linux/void-packages/commit/176d9655429188aac10cd229827f99b72982ab10)).
 
@@ -74,7 +74,7 @@ New packages will not be accepted unless they have been runtime tested.
 
 ### Starting a pull request
 
-Once you have successfully built the package, you can [create a pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).
+Once you have successfully built the package, you can [create a pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request). Pull requests are also known as PRs.
 
 Most pull requests should only contain a single package and dependencies which are not part of void-packages yet.
 
@@ -99,11 +99,10 @@ comply with the our guidelines. At the moment not all packages comply with the r
 
 #### Review
 
-Most of the time your pull request will contain mistakes. It's nothing bad, it just happens.
+It's possible (and common) that a pull request will contain mistakes or reviewers will ask for additional tweaks.
+Reviewers will comment on your pull request and point out which changes are needed before the pull request can be merged.
 
-Reviewers will comment on your pull request and point out which changes are needed before the template can be included.
-
-We recommend having only a single commit for pull request, so if you need to make changes in commits but already have a pull request, use the following commands:
+Most PRs will have a single commit, as seen [above](#committing-your-changes), so if you need to make changes to the commit and already have a pull request open, you can use the following commands:
 
     $ git add <file>
     $ git commit --amend

Re: [PR REVIEW] CONTRIBUTING.md: be clearer about "one commit per PR" rule.

[ericonr]

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

New review comment by ericonr on void-packages repository

https://github.com/void-linux/void-packages/pull/29568#discussion_r597162946

Comment:
Kinda picked it up but also extended a lot.

Re: [PR REVIEW] CONTRIBUTING.md: be clearer about "one commit per PR" rule.

[Chocimier]

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

New review comment by Chocimier on void-packages repository

https://github.com/void-linux/void-packages/pull/29568#discussion_r597170817

Comment:
"per package" was rarely interpreted as "per subpackage". Might we use "per package (with subpackages)" or "per template" or some longer form to make it clearer?

Re: [PR PATCH] [Updated] CONTRIBUTING.md: be clearer about "one commit per PR" rule.

[ericonr]

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

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

https://github.com/ericonr/void-packages contr
https://github.com/void-linux/void-packages/pull/29568

CONTRIBUTING.md: be clearer about "one commit per PR" rule.


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

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

From 63f850402f6eaca144666da39e4b26bf6baf620e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=89rico=20Nogueira?= <erico.erc@gmail.com>
Date: Thu, 18 Mar 2021 14:29:32 -0300
Subject: [PATCH] CONTRIBUTING.md: be clearer about "one commit per PR" rule.

---
 CONTRIBUTING.md | 11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 4cadfc6265b7..b68c4c601cd4 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -41,7 +41,7 @@ If `xlint` reports any issues, resolve them before committing.
 
 ### Committing your changes
 
-Once you have built your template file or files, the commit message should have one of the following forms:
+Once you have made and verified your changes to the package template and/or other files, make one commit per package (including all changes to its sub-packages). Each commit message should have one of the following formats:
 
 * for new packages, use ```New package: <pkgname>-<version>``` ([example](https://github.com/void-linux/void-packages/commit/176d9655429188aac10cd229827f99b72982ab10)).
 
@@ -74,7 +74,7 @@ New packages will not be accepted unless they have been runtime tested.
 
 ### Starting a pull request
 
-Once you have successfully built the package, you can [create a pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).
+Once you have successfully built the package, you can [create a pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request). Pull requests are also known as PRs.
 
 Most pull requests should only contain a single package and dependencies which are not part of void-packages yet.
 
@@ -99,11 +99,10 @@ comply with the our guidelines. At the moment not all packages comply with the r
 
 #### Review
 
-Most of the time your pull request will contain mistakes. It's nothing bad, it just happens.
+It's possible (and common) that a pull request will contain mistakes or reviewers will ask for additional tweaks.
+Reviewers will comment on your pull request and point out which changes are needed before the pull request can be merged.
 
-Reviewers will comment on your pull request and point out which changes are needed before the template can be included.
-
-We recommend having only a single commit for pull request, so if you need to make changes in commits but already have a pull request, use the following commands:
+Most PRs will have a single commit, as seen [above](#committing-your-changes), so if you need to make changes to the commit and already have a pull request open, you can use the following commands:
 
     $ git add <file>
     $ git commit --amend

Re: CONTRIBUTING.md: be clearer about "one commit per PR" rule.

[ericonr]

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

New comment by ericonr on void-packages repository

https://github.com/void-linux/void-packages/pull/29568#issuecomment-805416751

Comment:
@Chocimier I have updated it.

Re: [PR PATCH] [Merged]: CONTRIBUTING.md: be clearer about "one commit per PR" rule.

[ericonr]

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

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

CONTRIBUTING.md: be clearer about "one commit per PR" rule.
https://github.com/void-linux/void-packages/pull/29568

Description: