From 8b2ecb469374cfe9c9d0dbbd1be44aca3c5f1774 Mon Sep 17 00:00:00 2001 From: erciccione Date: Fri, 6 Sep 2019 12:36:19 +0200 Subject: [PATCH] CONTRIBUTING.md: add 'squash commits' to contributor's workflow --- CONTRIBUTING.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fb432c49060..c52d0bc989b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,6 +19,7 @@ All Bisq contributors submit changes via pull requests. The workflow is as follo - Fork the repository - Create a topic branch from the `master` branch - Commit patches + - Squash redundant or unnecessary commits - Submit a pull request from your topic branch back to the `master` branch of the main repository Pull requests should be focused on a single change. Do not mix, for example, refactorings with a bug fix or implementation of a new feature. This practice makes it easier for fellow contributors to review each pull request on its merits and and to give a clear ACK/NACK (see below). @@ -73,6 +74,10 @@ https://help.github.com/articles/signing-commits-with-gpg/ for instructions. The [.editorconfig](.editorconfig) settings in this repository ensure consistent management of whitespace, line endings and more. Most modern editors support it natively or with plugin. See http://editorconfig.org for details. See also [bisq-network/style#10](https://github.com/bisq-network/style/issues/10). +### Keep the git history clean + +It's very important to keep the git history clear, light and easily browsable. This means contributors must make sure their pull requests include only meaningful commits (if they are redundant or were added after a review, they should be removed) and _no merge commits_. + ### Additional style guidelines See the issues in the [bisq-network/style](https://github.com/bisq-network/style/issues) repository.