[PATCH] Add commit message guidelines to developer policy

hfinkel at anl.gov hfinkel at anl.gov
Tue Mar 10 07:46:47 PDT 2015


Comment at: docs/DeveloperPolicy.rst:306
@@ +305,3 @@
+While these rules match most of the cases, we're aware that some cases are not
+covered, and that's why we don't think reverting patches with "bad" commit
jroelofs wrote:
> hfinkel wrote:
> > I'd remove this paragraph. I don't think we should commit to this. ;)
> > 
> I do think it's worth mentioning some guideline on what to do about commits with the wrong message vs commits with messages that don't quite fit this style. I think there are cases where it does make sense to revert & re-apply, and others where it's not worth it.
Fair enough, but if someone were to commit something with a message of "stuff" or "working on it", etc. (which has happened in the past by accident), reverting might certainly be appropriate. We have also, IIRC, reverted in the past because of lack of proper attribution (although normally a follow-up to the commits list is sent to correct omissions). Maybe some statement such as:

  For minor violations of this policy, the community normally favors reminding the contributor of this policy over reverting. Minor corrections and omissions can be handled by sending a reply to the commits mailing list.



More information about the cfe-commits mailing list