File 0928-Clarify-how-to-make-contributions.patch of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 0928-Clarify-how-to-make-contributions.patch of Package erlang (Revision d8745da60831eabc081dfb26c3d6ac22)

Currently displaying revision d8745da60831eabc081dfb26c3d6ac22 , Show latest

From 1ae371d56a8c6f25d0bb80cb9b5d54a3866b6712 Mon Sep 17 00:00:00 2001
From: Ingela Anderton Andin <ingela@erlang.org>
Date: Wed, 10 Jun 2020 11:54:39 +0200
Subject: [PATCH] Clarify how to make contributions

We want it to be as easy as possible to review a pull request without
breaking the possibility to use bisect.

The need for improvement was discovered due to PR-1968 and a first
enhancement proposal made in PR-2652, but we discovered it needed to
be reworded to fulfill our whole requirement.
---
 CONTRIBUTING.md | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b754fbd662..068ae0507e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -71,8 +71,11 @@ Make sure that your branch contains clean commits:
 * Don't merge `maint` or `master` into your branch. Use `git rebase` if you need to resolve merge
 conflicts or include the latest changes.
 
-* To make it possible to use the powerful `git bisect` command, make sure that each commit can be
-compiled and that it works.
+* Each commit should represent a logical change, such as a feature added or bug fixed, and also include relevant changes to documentation and tests.
+
+* Each commit should compile separately and pass the most relevant test cases. This makes it possible to use the powerful `git bisect` command.
+
+* Changes to multiple applications should be made in separate commits to facilitate code reviews, unless special circumstances motivates a single commit, such as not breaking the ability to build cleanly.
 
 * Check for unnecessary whitespace before committing with `git diff --check`.
 
-- 
2.26.2

Places

File 0928-Clarify-how-to-make-contributions.patch of Package erlang (Revision d8745da60831eabc081dfb26c3d6ac22)

Places