Edited docs/contributing.txt changes from [4190]

git-svn-id: http://code.djangoproject.com/svn/django/trunk@4191 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
Adrian Holovaty 2006-12-11 01:24:33 +00:00
parent 08ba8e841b
commit 5c8d789efe
1 changed files with 18 additions and 18 deletions

View File

@ -137,34 +137,34 @@ Patch style
Non-trivial patches Non-trivial patches
------------------- -------------------
If a patch is non-trivial, there should be some evidence that there A "non-trivial" patch is one that is more than a simple bug fix. It's a patch
has been discussion on `django-developers`_ of any alternatives. that introduces Django functionality and makes some sort of design decision.
Note that 'non-trivial' doesn't just mean 'only affects 1-2 lines
of code' - it also includes the fact that the lines that are being If you provide a non-trivial patch, include evidence that alternatives have
modified don't have a significant follow-on effect on the overall been discussed on `django-developers`_. If you're not sure whether your patch
design of Django. If in doubt, ask. should be considered non-trivial, just ask.
Ticket triage Ticket triage
============= =============
Unfortunately, not all bug reports in the `ticket tracker`_ provide all Unfortunately, not all bug reports in the `ticket tracker`_ provide all
the `required details`_. Other tickets have patches, but those patches the `required details`_. A number of tickets have patches, but those patches
do not meet all the requirements of a `good patch`_. don't meet all the requirements of a `good patch`_.
One way to help out is to triage bugs that have been reported by other users. One way to help out is to *triage* bugs that have been reported by other users.
Pick an open ticket that is missing some details, and try to replicate the Pick an open ticket that is missing some details, and try to replicate the
problem. Fill in the missing pieces of the report. If the ticket doesn't have problem. Fill in the missing pieces of the report. If the ticket doesn't have
a patch, create one. a patch, create one.
Once you have completed all the missing details on the ticket and you have a Once you've completed all the missing details on the ticket and you have a
patch with all the required features, mail `django-developers`_. Indicate that patch with all the required features, e-mail `django-developers`_. Indicate
you have triaged a ticket, and recommend a course of action for dealing with that you have triaged a ticket, and recommend a course of action for dealing
that ticket. with that ticket.
At first, this may require you to be persistent - if you find that your triaged At first, this may require you to be persistent. If you find that your triaged
ticket still isn't getting attention, occasional polite requests for eyeballs to ticket still isn't getting attention, occasional polite requests for eyeballs
look at your ticket may be necessary. However, as you earn a reputation for to look at your ticket may be necessary. However, as you earn a reputation for
quality triage work, you should find that it is easier to get the developers quality triage work, you should find that it is easier to get the developers'
attention. attention.
.. _required details: `Reporting bugs`_ .. _required details: `Reporting bugs`_