Added a few more bullets to docs/contributing.txt 'Committing code' section

git-svn-id: http://code.djangoproject.com/svn/django/trunk@1858 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
Adrian Holovaty 2006-01-08 06:30:56 +00:00
parent 05c9a3b13f
commit e3ba51397a
1 changed files with 20 additions and 3 deletions

View File

@ -174,6 +174,10 @@ Committing code
Please follow these guidelines when committing code to Django's Subversion Please follow these guidelines when committing code to Django's Subversion
repository: repository:
* For any medium-to-big changes, where "medium-to-big" is according to your
judgment, please bring things up on the `django-developers`_ mailing list
before making the change.
* Write detailed commit messages in the past tense, not present tense. * Write detailed commit messages in the past tense, not present tense.
* Good: "Fixed bug in RSS API." * Good: "Fixed bug in RSS API."
@ -190,9 +194,22 @@ repository:
commit. This goes a *long way* in helping all core Django developers commit. This goes a *long way* in helping all core Django developers
follow your changes. follow your changes.
* For any medium-to-big changes, where "medium-to-big" is according to your * If your commit closes a ticket in the Django `ticket tracker`_, begin
judgment, please bring things up on the `django-developers`_ mailing list your commit message with the text "Fixed #abc", where "abc" is the number
before making the change. of the ticket your commit fixes. Example: "Fixed #123 -- Added support
for foo". We've rigged Subversion and Trac so that any commit message
in that format will automatically close the referenced ticket and post a
comment to it with the full commit message.
If your commit closes a ticket and is in a branch, use the branch name
first, then the "Fixed #abc." For example:
"magic-removal: Fixed #123 -- Added whizbang feature."
* If your commit references a ticket in the Django `ticket tracker`_,
include the phrase "Refs #abc", where "abc" is the number of the ticket
your commit references. We've rigged Subversion and Trac so that any
commit message in that format will automatically post a comment to the
appropriate ticket.
Requesting features Requesting features
=================== ===================