[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Dolibarr-dev] New rule for commit comments for Dolibarr pull requests

From: Laurent Destailleur (aka Eldy)
Subject: [Dolibarr-dev] New rule for commit comments for Dolibarr pull requests
Date: Fri, 23 Jan 2015 02:49:14 +0100

To reduce works and increase number of code submissions I can validate without conflict with other code change, this is new rule that apply from now for the all submission of code fixes or enhancements to Dolibarr project, for the develop branch.

* Do not fill anymore the file ChangeLog (yes i said do NOT).
This will reduce seriously the number of conflicts of Pull Requests submitted via GitHub.
Also content was not always correct.

* Instead, when you submit a PR, use a clear comment of your change with the folliwng syntax:

NEW My new feature


FIXED #123
FIXED i fix this awful bug


a free text...

The Changelog will then be generated during release by an extract of all log commits starting with NEW and FIX. Any other change without this will not be reported into changelog but this just means it is not something to mention into Changelog.
Of course to have this working correctly, i may modify during validation step of any PR, the log comment to folow this.

I hope this will reduce number of conflict to manage manually, make Changelog more rigourus and not loosing some entries because they will be generated automatically.

Thanks to follow this rule for all change for develop branch.
For old branch (3.7, 3.6, ...), please continue to follow the changelof as you did by including the file into your PR.

Laurent Destailleur (aka Eldy)
Dolibarr Yoda.

reply via email to

[Prev in Thread] Current Thread [Next in Thread]