From f066ef76522719e587575780bfbfec8c42119ebd Mon Sep 17 00:00:00 2001 From: Sonata CI Date: Mon, 30 May 2016 08:00:07 +0200 Subject: [PATCH] DevKit updates --- CONTRIBUTING.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 38c993e9d..b8706b52d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -84,14 +84,17 @@ on your PR explaining why you feel it is the case. #### The Change log -On each PR, the `CHANGELOG.md` file **has to be updated**. +For each PR, a change log must be provided. -There are few cases where the `CHANGELOG.md` file should not be touched: +There are few cases where no change log is necessary: * When you fix a bug on an unreleased feature. * When your PR concerns only the documentation (fix or improvement). -The change log note has to be put below the `## [Unreleased]` section. +**Do not** edit the `CHANGELOG.md` directly though, because having every +contributor write PR with changes in the same file, at roughly the same line is +a recipe for conflicts. Instead, fill in the dedicated section that should +appear in a textaread when submitting your PR. Your note can be put on one of these sections: