From b870cf1533d8f0e19f6c8e5d909dcff5df42dc33 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89rico=20Nogueira?= 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 $ git commit --amend