Difference between revisions of "Commit Guidelines"

Jump to navigation Jump to search
(Update commit guidelines as per Eugene's email on -devel)
m (typos)
Line 51: Line 51:
* "" -> empty commit messages are about the worst you can do :-/ (short of insults and totally offtopic messages).
* "" -> empty commit messages are about the worst you can do :-/ (short of insults and totally offtopic messages).


Always keep in mind -- those message are often read *without* seeing the diffs, and without the possibility to see which other files you commited just before that particular commit!
Always keep in mind -- those message are often read *without* seeing the diffs, and without the possibility to see which other files you committed just before that particular commit!


Compare this to
Compare this to
Line 59: Line 59:
* "Add patch #1374870 - New Lure of the Temptress module"
* "Add patch #1374870 - New Lure of the Temptress module"


Don't be too verbose in your message either. You don't have to tell people what the next step in the grand scheme are in a long paragraph.
Don't be too verbose in your message either. You don't have to tell people what the next step in the grand scheme is in a long paragraph.