diff options
| author |   Alexander Berntsen <bernalex@gentoo.org> | 2014-03-27 13:42:33 +0100 |
|---|---|---|
| committer | Alexander Berntsen <bernalex@gentoo.org> | 2014-03-29 01:01:04 +0100 |
| commit | 8e3e0ac212a3847638c83edc1b752dadbfd5cd9d (patch) | |
| tree | 00d51960c3cff33d2e4020d0e93da39740a2cfdd /DEVELOPING | |
| parent | DEVELOPING: Add note on commits (diff) | |
| download | gentoo-portage-8e3e0ac212a3847638c83edc1b752dadbfd5cd9d.tar.xz gentoo-portage-8e3e0ac212a3847638c83edc1b752dadbfd5cd9d.zip | |
DEVELOPING: Add note on commit messages
Diffstat (limited to 'DEVELOPING')
| -rw-r--r-- | DEVELOPING | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/DEVELOPING b/DEVELOPING index 97316102ae27..cfa86a66a9ea 100644 --- a/DEVELOPING +++ b/DEVELOPING @@ -175,6 +175,26 @@ change a lot of unrelated things. This makes it easier to see what parts of the system have actually changed. It also makes it easier to cherry-pick and revert commits. Use your common sense! +Commit messages +--------------- + +Commit messages should be in the imperative mood with a capitalised +header, optionally followed by a newline and a more detailed explanatory +text. The headline should be capped at 50 characters, the detailed text +at 72. Prefix the message with the component you touched if this makes +sense. Postfix the message with the bug it fixes, if it does. Example: + +" +emerge: Fix --tree output (bug 555555) + +Make sure newlines appear where they are supposed to. Fix a bug with +colourisation of --tree output when used in tandem with --verbose +--pretend --ask. +" + +For a more detailed explanation (and rationalisation) of these rules: +<http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html> + Releases -------- |