diff options
author | Andreas Rumpf <rumpf_a@web.de> | 2019-09-25 15:01:35 +0200 |
---|---|---|
committer | Andreas Rumpf <rumpf_a@web.de> | 2019-09-25 15:01:35 +0200 |
commit | 5f44651769cfa0c07d0bcfefb47fdf73dfb9982e (patch) | |
tree | 04cfecd65c28bf930195758a4bb53e5415e4fede | |
parent | 6b4b329f45ce23fc7590c2c9fb3cc50715b266a1 (diff) | |
download | Nim-5f44651769cfa0c07d0bcfefb47fdf73dfb9982e.tar.gz |
updated the contributing.rst guidelines
-rw-r--r-- | doc/contributing.rst | 16 |
1 files changed, 4 insertions, 12 deletions
diff --git a/doc/contributing.rst b/doc/contributing.rst index 8699002ae..9942b68a0 100644 --- a/doc/contributing.rst +++ b/doc/contributing.rst @@ -140,9 +140,6 @@ commands. Comparing tests =============== -Because some tests fail in the current ``devel`` branch, not every failure -after your change is necessarily caused by your changes. Some tests are -flaky and will fail on occasion; these are typically bugs that should be fixed. Test failures can be grepped using ``Failure:``. The tester can compare two test runs. First, you need to create the @@ -348,15 +345,10 @@ The Git stuff General commit rules -------------------- -1. The commit message should contain either ``[bugfix]`` or ``[feature]`` - or ``[refactoring]`` or ``[other]``. In practice however this is very - often forgotten and a commit message like ``fixes #xyz`` is good enough. - - Every commit is backported unless - tagged with either ``[feature]`` or with ``[nobackport]``. They are - backported to the latest stable release branch (currently 0.20.x). - - Refactorings are backported because they often enable further bugfixes. +1. Important, critical bugfixes that have a tiny chance of breaking + somebody's code should be backported to the latest stable release + branch (currently 1.0.x). The commit message should contain ``[backport]`` + then. 2. If you introduce changes which affect backwards compatibility, make breaking changes, or have PR which is tagged as ``[feature]``, |