Github messages for voidlinux
 help / color / mirror / Atom feed
From: ericonr <ericonr@users.noreply.github.com>
To: ml@inbox.vuxu.org
Subject: Re: [PR PATCH] [Updated] CONTRIBUTING.md: be clearer about "one commit per PR" rule.
Date: Thu, 18 Mar 2021 20:05:52 +0100	[thread overview]
Message-ID: <20210318190552.fam2xZg3ptlDiBV72bPGjPum74mZiWhFuYs9yhoC7p4@z> (raw)
In-Reply-To: <gh-mailinglist-notifications-41a7ca26-5023-4802-975b-f1789d68868e-void-packages-29568@inbox.vuxu.org>

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

  parent reply	other threads:[~2021-03-18 19:05 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-18 17:30 [PR PATCH] " ericonr
2021-03-18 18:25 ` [PR REVIEW] " Chocimier
2021-03-18 19:05 ` ericonr [this message]
2021-03-18 19:06 ` ericonr
2021-03-18 19:18 ` Chocimier
2021-03-24  2:03 ` [PR PATCH] [Updated] " ericonr
2021-03-24  2:03 ` ericonr
2021-03-24  3:13 ` [PR PATCH] [Merged]: " ericonr

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210318190552.fam2xZg3ptlDiBV72bPGjPum74mZiWhFuYs9yhoC7p4@z \
    --to=ericonr@users.noreply.github.com \
    --cc=ml@inbox.vuxu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).