Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

[1.0.X] Fixed #10110 -- Added FAQ on how and when to poke the core de…

…velopers about tickets. Thanks to Graham King for turning a couple of django-dev posts into a good first draft.

Merge of r9789 from trunk.


git-svn-id: http://code.djangoproject.com/svn/django/branches/releases/1.0.X@9790 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
commit 405b87c4320093b4152b1a49a2f6e80780a5fdd0 1 parent 47ed900
Russell Keith-Magee authored January 24, 2009

Showing 1 changed file with 78 additions and 4 deletions. Show diff stats Hide diff stats

  1. 82  docs/faq/contributing.txt
82  docs/faq/contributing.txt
@@ -24,7 +24,81 @@ the amount of time that we have to work on the framework is limited and will
24 24
 vary from week to week depending on our spare time. If we're busy, we may not
25 25
 be able to spend as much time on Django as we might want.
26 26
 
27  
-Besides, if your feature request stands no chance of inclusion in Django, we
28  
-won't ignore it -- we'll just close the ticket. So if your ticket is still
29  
-open, it doesn't mean we're ignoring you; it just means we haven't had time to
30  
-look at it yet.
  27
+The best way to make sure tickets do not get hung up on the way to checkin is
  28
+to make it dead easy, even for someone who may not be intimately familiar with
  29
+that area of the code, to understand the problem and verify the fix:
  30
+
  31
+    * Are there clear instructions on how to reproduce the bug? If this
  32
+      touches a dependency (such as PIL), a contrib module, or a specific
  33
+      database, are those instructions clear enough even for someone not
  34
+      familiar with it?
  35
+
  36
+    * If there are several patches attached to the ticket, is it clear what
  37
+      each one does, which ones can be ignored and which matter?
  38
+
  39
+    * Does the patch include a unit test? If not, is there a very clear
  40
+      explanation why not? A test expresses succinctly what the problem is,
  41
+      and shows that the patch actually fixes it.
  42
+
  43
+If your patch stands no chance of inclusion in Django, we won't ignore it --
  44
+we'll just close the ticket. So if your ticket is still open, it doesn't mean
  45
+we're ignoring you; it just means we haven't had time to look at it yet.
  46
+
  47
+When and how might I remind the core team of a patch I care about?
  48
+------------------------------------------------------------------
  49
+
  50
+A polite, well-timed message to the mailing list is one way to get attention.
  51
+To determine the right time, you need to keep an eye on the schedule. If you
  52
+post your message when the core developers are trying to hit a feature
  53
+deadline or manage a planning phase, you're not going to get the sort of
  54
+attention you require. However, if you draw attention to a ticket when the
  55
+core developers are paying particular attention to bugs -- just before a bug
  56
+fixing sprint, or in the lead up to a beta release for example -- you're much
  57
+more likely to get a productive response.
  58
+
  59
+Gentle IRC reminders can also work -- again, strategically timed if possible.
  60
+During a bug sprint would be a very good time, for example.
  61
+
  62
+Another way to get traction is to pull several related tickets together. When
  63
+the core developers sit down to fix a bug in an area they haven't touched for
  64
+a while, it can take a few minutes to remember all the fine details of how
  65
+that area of code works. If you collect several minor bug fixes together into
  66
+a similarly themed group, you make an attractive target, as the cost of coming
  67
+up to speed on an area of code can be spread over multiple tickets.
  68
+
  69
+Please refrain from emailing core developers personally, or repeatedly raising
  70
+the same issue over and over. This sort of behavior will not gain you any
  71
+additional attention -- certainly not the attention that you need in order to
  72
+get your pet bug addressed.
  73
+
  74
+But I've reminded you several times and you keep ignoring my patch!
  75
+-------------------------------------------------------------------
  76
+
  77
+Seriously - we're not ignoring you. If your patch stands no chance of
  78
+inclusion in Django, we'll close the ticket. For all the other tickets, we
  79
+need to prioritize our efforts, which means that some tickets will be
  80
+addressed before others.
  81
+
  82
+One of the criteria that is used to prioritize bug fixes is the number of
  83
+people that will likely be affected by a given bug. Bugs that have the
  84
+potential to affect many people will generally get priority over those that
  85
+are edge cases.
  86
+
  87
+Another reason that bugs might be ignored for while is if the bug is a symptom
  88
+of a larger problem. While we can spend time writing, testing and applying
  89
+lots of little patches, sometimes the right solution is to rebuild. If a
  90
+rebuild or refactor of a particular component has been proposed or is
  91
+underway, you may find that bugs affecting that component will not get as much
  92
+attention. Again, this is just a matter of prioritizing scarce resources. By
  93
+concentrating on the rebuild, we can close all the little bugs at once, and
  94
+hopefully prevent other little bugs from appearing in the future.
  95
+
  96
+Whatever the reason, please keep in mind that while you may hit a particular
  97
+bug regularly, it doesn't necessarily follow that every single Django user
  98
+will hit the same bug. Different users use Django in different ways, stressing
  99
+different parts of the code under different conditions. When we evaluate the
  100
+relative priorities, we are generally trying to consider the needs of the
  101
+entire community, not just the severity for one particular user. This doesn't
  102
+mean that we think your problem is unimportant -- just that in the limited
  103
+time we have available, we will always err on the side of making 10 people
  104
+happy rather than making 1 person happy.

0 notes on commit 405b87c

Please sign in to comment.
Something went wrong with that request. Please try again.