jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

updated the contributing.rst guidelines

Browse source
This commit is contained in:
Andreas Rumpf 2019-09-25 15:01:35 +02:00
commit 5f44651769
1 changed files with 4 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

16
doc/contributing.rst
View file

@ -140,9 +140,6 @@ commands.
Comparing tests 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:``. Test failures can be grepped using ``Failure:``.
The tester can compare two test runs. First, you need to create the The tester can compare two test runs. First, you need to create the
@ -348,15 +345,10 @@ The Git stuff
General commit rules General commit rules
-------------------- --------------------
1. The commit message should contain either ``[bugfix]`` or ``[feature]`` 1. Important, critical bugfixes that have a tiny chance of breaking
or ``[refactoring]`` or ``[other]``. In practice however this is very somebody's code should be backported to the latest stable release
often forgotten and a commit message like ``fixes #xyz`` is good enough. branch (currently 1.0.x). The commit message should contain ``[backport]``
then.
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.
2. If you introduce changes which affect backwards compatibility, 2. If you introduce changes which affect backwards compatibility,
make breaking changes, or have PR which is tagged as ``[feature]``, make breaking changes, or have PR which is tagged as ``[feature]``,