[Top][All Lists]

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

Re: [Dolibarr-dev] New rule for commit comments for Dolibarr pull reques

From: Doursenaud , Raphaël
Subject: Re: [Dolibarr-dev] New rule for commit comments for Dolibarr pull requests
Date: Fri, 23 Jan 2015 15:05:27 +0100

Great move!

I formalized this as a GitHub contributing guideline. These appear before any pull request or issue creation.


Feel free to make it better ;)

Also, I think we could go one step further and include the functional part (module) in the commit message as well.


2015-01-23 12:59 GMT+01:00 Sasa Ostrouska <address@hidden>:

On Fri, Jan 23, 2015 at 1:49 AM, Laurent Destailleur (aka Eldy) <address@hidden> wrote:

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.

I think this is a great move ! This will in fact speed up things for you Laurent.


Dolibarr-dev mailing list

Raphaël Doursenaud
Directeur technique (CTO)
Expert certifié en déploiement Google Apps
+33 (0)5 35 53 97 13 - +33 (0)6 68 48 20 10
Technopole Hélioparc
2 avenue du Président Pierre Angot
64053 PAU CEDEX 9
SARL au capital de 7 500 € - R.C.S. PAU 528 995 921

reply via email to

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