From c3b4e589786d5c82009a27b8281dcef54ecf2cf6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johannes=20Sch=C3=B6nberger?= Date: Wed, 11 Jun 2014 07:28:48 -0400 Subject: [PATCH] Describe new release note dev process For upcoming contributions, every contributor should document the contributed changes, before merging the PR. --- CONTRIBUTING.txt | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.txt b/CONTRIBUTING.txt index 202210a1..837dca2a 100644 --- a/CONTRIBUTING.txt +++ b/CONTRIBUTING.txt @@ -77,6 +77,12 @@ For a more detailed discussion, read these :doc:`detailed documents Travis fails, you can find out why by clicking on the "failed" icon (red cross) and inspecting the build and test log. +5. Document changes + + Before merging your commits, you must add a description of your changes + to the release notes of the upcoming version in + ``doc/release/release_dev.txt``. + .. note:: To reviewers: if it is not obvious, add a short explanation of what a branch @@ -85,7 +91,7 @@ For a more detailed discussion, read these :doc:`detailed documents Divergence between ``upstream master`` and your feature branch -.............................................................. +-------------------------------------------------------------- Do *not* ever merge the main branch into yours. If GitHub indicates that the branch of your Pull Request can no longer be merged automatically, rebase