Last modified: 2013-07-30 20:54:40 UTC
Idea: commit message template that gently, briefly encourages people to write commit messages that are human-readable. (Explain what the situation was and what got fixed.) More ideas welcome & to come.
I'm not quite sure what you're wanting here? Is this a feature for gerrit? Commit messages are done on your local machine before pushing. We've had https://www.mediawiki.org/wiki/Gerrit/Commit_message_guidelines for some time, maybe it just needs more prominent linking?
A possibility would be to have a prepare-commit-msg hook in git that would be setup by git-review.
Yes, a hook that would prepare a commit message along these lines: ------------------------------------------- <a title for this commit> What was the problem? <explain here> How does this change fix it? <explain here> How to test it? <explain here> Bug: XXXX ------------------------------------------- (I just made this up. The content is totally up for discussion.) There's a chance that such a template will encourage people to write commit messages that will help others understand, review and test the changes. If it's possible to push such a hook to everybody through the repos, it would be nice.
(In reply to comment #3) > If it's possible to push such a hook to everybody through the repos, it would > be nice. That's not possible. (In reply to comment #2) > A possibility would be to have a prepare-commit-msg hook in git that would be > setup by git-review. That is.
Amir is the one who originally came up with this idea (during Open Source Bridge) so if it were possible to change the reporter for this issue to him then I'd suggest that. :) His comment #3 reflects what I'd like. https://www.mediawiki.org/wiki/Manual_talk:Coding_conventions/PHP#Recommending_some_minimum_documentation_practices has some additional ideas regarding what we could put into the prepare-commit-msg hook.
We could create such a hook, but there's no way to get it on people's hosts automatically fwiw (hooks are not tracked in git repos). So whatever we did, it'd require some bit of manual setup for users :(
