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

updates the contributing guidelines [other]

Browse source
This commit is contained in:
Andreas Rumpf 2019-06-07 16:21:01 +02:00
commit 2c03c9f42e
1 changed files with 4 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

10
doc/contributing.rst
View file

@ -343,12 +343,10 @@ The Git stuff
General commit rules
--------------------
1. Bugfixes that should be backported to the latest stable release should
contain the string ``[backport]`` in the commit message! There will be an
outmated process relying on these. However, bugfixes also have the inherent
risk of causing regressions which are worse for a "stable, bugfixes-only"
branch, so in doubt, leave out the ``[backport]``. Standard library bugfixes
are less critical than compiler bugfixes.
1. The commit message should contain either ``[bugfix]`` or ``[feature]``
or ``[refactoring]`` or ``[other]``. Refactorings and bugfixes and "other"
are backported to the latest stable release branch (currently 0.20.x).
Refactorings are backported because they often enable further bugfixes.
2. All changes introduced by the commit (diff lines) must be related to the
subject of the commit.