diff options
| author | Ralf Gommers <ralf.gommers@googlemail.com> | 2012-09-22 16:39:02 +0200 |
|---|---|---|
| committer | Ralf Gommers <ralf.gommers@googlemail.com> | 2012-09-22 16:39:02 +0200 |
| commit | 5a6601af7696c277310df44ad7cea6a84c01d8bc (patch) | |
| tree | 60c8e2f9656610a462ff17c01d019839d05c84c9 /doc/source/dev/gitwash/development_workflow.rst | |
| parent | fd63e8f7dcbab6b7c66bd4be400153592319e7b3 (diff) | |
| download | numpy-5a6601af7696c277310df44ad7cea6a84c01d8bc.tar.gz | |
DOC: document in dev-guide how to write a good commit message.
Diffstat (limited to 'doc/source/dev/gitwash/development_workflow.rst')
| -rw-r--r-- | doc/source/dev/gitwash/development_workflow.rst | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/doc/source/dev/gitwash/development_workflow.rst b/doc/source/dev/gitwash/development_workflow.rst index 75de6ae67..9cdfec58f 100644 --- a/doc/source/dev/gitwash/development_workflow.rst +++ b/doc/source/dev/gitwash/development_workflow.rst @@ -150,6 +150,34 @@ In more detail #. To push the changes up to your forked repo on github_, do a ``git push`` (see `git push`). +Writing the commit message +-------------------------- + +Commit messages should be clear and follow a few basic rules. Example:: + + ENH: add functionality X to numpy.<submodule>. + + The first line of the commit message starts with a capitalized acronym + (options listed below) indicating what type of commit this is. Then a blank + line, then more text if needed. Lines shouldn't be longer than 80 + characters. If the commit is related to a ticket, indicate that with + "See #3456", "See ticket 3456", "Closes #3456" or similar. + +Standard acronyms to start the commit message with are:: + + API: an (incompatible) API change + BLD: change related to building numpy + BUG: bug fix + DEP: deprecate something, or remove a deprecated object + DEV: development tool or utility + DOC: documentation + ENH: enhancement + MAINT: maintenance commit (refactoring, typos, etc.) + REV: revert an earlier commit + STY: style fix (whitespace, PEP8) + TST: addition or modification of tests + REL: related to releasing numpy + .. _rebasing-on-master: |