Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/checkpoint-restore/criu.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMike Rapoport <rppt@linux.ibm.com>2020-06-14 11:26:14 +0300
committerAndrei Vagin <avagin@gmail.com>2020-10-20 10:18:24 +0300
commit6815aa958d1ac01f0dd0c81d55475d44aabfff88 (patch)
tree6e56733ba9094d117b12d98037281d423f17d501 /CONTRIBUTING.md
parent35f8c056ac49ab62b8575a2d1f04cbbd94ccff5b (diff)
CONTRIBUTING.md: add pull request guidelines
Following the discussion at [1] describe best practices for pull request creation. [1] https://github.com/checkpoint-restore/criu/pull/1096 Signed-off-by: Mike Rapoport <rppt@linux.ibm.com>
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 1c731b7f8..d40f0014c 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -216,6 +216,44 @@ commit message. To append such line to a commit you already made, use
We accept GitHub pull requests and this is the preferred way to contribute to CRIU.
For that you should push your work to your fork of CRIU at [GitHub](https://github.com) and create a [pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests)
+### Pull request guidelines
+
+Pull request comment should contain description of the problem your changes
+solve and a brief outline of the changes included in the pull request.
+
+Please avoid pushing fixup commits to an existent pull request. Each commit
+should be self contained and there should not be fixup commits in a patch
+series. Pull requests that contain one commit which breaks something
+and another commit which fixes it, will be rejected.
+
+Please merge the fixup commits into the commits that has introduced the
+problem before creating a pull request.
+
+It may happen that the reviewers were not completely happy with your
+changes and requested changes to your patches. After you updated your
+changes please close the old pull request and create a new one that
+contains the following:
+
+* Description of the problem your changes solve and a brief outline of the
+ changes
+* Link to the previous version of the pull request
+* Brief description of the changes between old and new versions of the pull
+ request. If there were more than one previous pull request, all the
+ revisions should be listed. For example:
+
+```
+ v3: rebase on the current criu-dev
+ v2: add commit to foo() and update bar() coding style
+```
+
+If there are only minor updates to the commits in a pull request, it is
+possible to force-push them into an existing pull request. This only applies
+to small changes and should be used with care. If you update an existing
+pull request, remember to add the description of the changes from the
+previous version.
+
+### Mailing list submission
+
Historically, CRIU worked with mailing lists and patches so if you still prefer this way continue reading till the end of this section.
### Make a patch