aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorÉrico Nogueira <erico.erc@gmail.com>2021-03-18 17:29:32 +0000
committerÉrico Nogueira Rolim <34201958+ericonr@users.noreply.github.com>2021-03-24 03:13:46 +0000
commit52258560741b20655923812a9ca1728775885937 (patch)
tree18899ec8e72a528f7f77a93617731b03aec3662a /CONTRIBUTING.md
parente03147ee6214caa87fef49d3598f9497b19204cf (diff)
downloadvoid-packages-52258560741b20655923812a9ca1728775885937.tar
void-packages-52258560741b20655923812a9ca1728775885937.tar.gz
void-packages-52258560741b20655923812a9ca1728775885937.tar.bz2
void-packages-52258560741b20655923812a9ca1728775885937.tar.lz
void-packages-52258560741b20655923812a9ca1728775885937.tar.xz
void-packages-52258560741b20655923812a9ca1728775885937.tar.zst
void-packages-52258560741b20655923812a9ca1728775885937.zip
CONTRIBUTING.md: be clearer about "one commit per PR" rule.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md11
1 files changed, 5 insertions, 6 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 4cadfc6265b..b68c4c601cd 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