2
0

bugs-and-features.txt 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214
  1. ======================================
  2. Reporting bugs and requesting features
  3. ======================================
  4. Before reporting a bug or requesting a new feature, please consider these
  5. general points:
  6. * Check that someone hasn't already filed the bug or feature request by
  7. `searching`_ or running `custom queries`_ in the ticket tracker.
  8. * Don't use the ticket system to ask support questions. Use the
  9. `django-users`_ list or the `#django`_ IRC channel for that.
  10. * Don't reopen issues that have been marked "wontfix" by a core developer.
  11. This mark means that the decision has been made that we can't or won't fix
  12. this particular issue. If you're not sure why, please ask
  13. on `django-developers`_.
  14. * Don't use the ticket tracker for lengthy discussions, because they're
  15. likely to get lost. If a particular ticket is controversial, please move the
  16. discussion to `django-developers`_.
  17. .. _reporting-bugs:
  18. Reporting bugs
  19. --------------
  20. Well-written bug reports are *incredibly* helpful. However, there's a certain
  21. amount of overhead involved in working with any bug tracking system so your
  22. help in keeping our ticket tracker as useful as possible is appreciated. In
  23. particular:
  24. * **Do** read the :doc:`FAQ </faq/index>` to see if your issue might
  25. be a well-known question.
  26. * **Do** ask on `django-users`_ or `#django`_ *first* if you're not sure if
  27. what you're seeing is a bug.
  28. * **Do** write complete, reproducible, specific bug reports. You must
  29. include a clear, concise description of the problem, and a set of
  30. instructions for replicating it. Add as much debug information as you can:
  31. code snippets, test cases, exception backtraces, screenshots, etc. A nice
  32. small test case is the best way to report a bug, as it gives us an easy
  33. way to confirm the bug quickly.
  34. * **Don't** post to `django-developers`_ just to announce that you have
  35. filed a bug report. All the tickets are mailed to another list,
  36. `django-updates`_, which is tracked by developers and interested
  37. community members; we see them as they are filed.
  38. To understand the lifecycle of your ticket once you have created it, refer to
  39. :doc:`triaging-tickets`.
  40. .. _django-updates: http://groups.google.com/group/django-updates
  41. .. _reporting-security-issues:
  42. Reporting security issues
  43. -------------------------
  44. .. Important::
  45. Please report security issues **only** to security@djangoproject.com.
  46. This is a private list only open to long-time, highly trusted Django
  47. developers, and its archives are not publicly readable.
  48. In the event of a confirmed vulnerability in Django itself, we will take the
  49. following actions:
  50. * Acknowledge to the reporter that we've received the report and that a
  51. fix is forthcoming. We'll give a rough timeline and ask the reporter
  52. to keep the issue confidential until we announce it.
  53. * Focus on developing a fix as quickly as possible and produce patches
  54. against the current and two previous releases.
  55. * Determine a go-public date for announcing the vulnerability and the fix.
  56. To try to mitigate a possible "arms race" between those applying the
  57. patch and those trying to exploit the hole, we will not announce
  58. security problems immediately.
  59. * Pre-notify third-party distributors of Django ("vendors"). We will send
  60. these vendor notifications through private email which will include
  61. documentation of the vulnerability, links to the relevant patch(es), and
  62. a request to keep the vulnerability confidential until the official
  63. go-public date.
  64. * Publicly announce the vulnerability and the fix on the pre-determined
  65. go-public date. This will probably mean a new release of Django, but
  66. in some cases it may simply be patches against current releases.
  67. Reporting user interface bugs and features
  68. ------------------------------------------
  69. If your bug or feature request touches on anything visual in nature, there
  70. are a few additional guidelines to follow:
  71. * Include screenshots in your ticket which are the visual equivalent of a
  72. minimal testcase. Show off the issue, not the crazy customizations
  73. you've made to your browser.
  74. * If the issue is difficult to show off using a still image, consider
  75. capturing a *brief* screencast. If your software permits it, capture only
  76. the relevant area of the screen.
  77. * If you're offering a patch which changes the look or behavior of Django's
  78. UI, you **must** attach before *and* after screenshots/screencasts.
  79. Tickets lacking these are difficult for triagers and core developers to
  80. assess quickly.
  81. * Screenshots don't absolve you of other good reporting practices. Make sure
  82. to include URLs, code snippets, and step-by-step instructions on how to
  83. reproduce the behavior visible in the screenshots.
  84. * Make sure to set the UI/UX flag on the ticket so interested parties can
  85. find your ticket.
  86. Requesting features
  87. -------------------
  88. We're always trying to make Django better, and your feature requests are a key
  89. part of that. Here are some tips on how to make a request most effectively:
  90. * Make sure the feature actually requires changes in Django's core. If your
  91. idea can be developed as an independent application or module — for
  92. instance, you want to support another database engine — we'll probably
  93. suggest that you to develop it independently. Then, if your project
  94. gathers sufficient community support, we may consider it for inclusion in
  95. Django.
  96. * First request the feature on the `django-developers`_ list, not in the
  97. ticket tracker. It'll get read more closely if it's on the mailing list.
  98. This is even more important for large-scale feature requests. We like to
  99. discuss any big changes to Django's core on the mailing list before
  100. actually working on them.
  101. * Describe clearly and concisely what the missing feature is and how you'd
  102. like to see it implemented. Include example code (non-functional is OK)
  103. if possible.
  104. * Explain *why* you'd like the feature. In some cases this is obvious, but
  105. since Django is designed to help real developers get real work done,
  106. you'll need to explain it, if it isn't obvious why the feature would be
  107. useful.
  108. If core developers agree on the feature, then it's appropriate to create a
  109. ticket. Include a link the discussion on `django-developers`_ in the ticket
  110. description.
  111. As with most open-source projects, code talks. If you are willing to write the
  112. code for the feature yourself or, even better, if you've already written it,
  113. it's much more likely to be accepted. If it's a large feature that might need
  114. multiple developers, we're always happy to give you an experimental branch in
  115. our repository; see the :doc:`writing-code/branch-policy`.
  116. See also: :ref:`documenting-new-features`.
  117. .. _how-we-make-decisions:
  118. How we make decisions
  119. ---------------------
  120. Whenever possible, we strive for a rough consensus. To that end, we'll often
  121. have informal votes on `django-developers`_ about a feature. In these votes we
  122. follow the voting style invented by Apache and used on Python itself, where
  123. votes are given as +1, +0, -0, or -1. Roughly translated, these votes mean:
  124. * +1: "I love the idea and I'm strongly committed to it."
  125. * +0: "Sounds OK to me."
  126. * -0: "I'm not thrilled, but I won't stand in the way."
  127. * -1: "I strongly disagree and would be very unhappy to see the idea turn
  128. into reality."
  129. Although these votes on `django-developers`_ are informal, they'll be taken very
  130. seriously. After a suitable voting period, if an obvious consensus arises we'll
  131. follow the votes.
  132. However, consensus is not always possible. If consensus cannot be reached, or
  133. if the discussion towards a consensus fizzles out without a concrete decision,
  134. we use a more formal process.
  135. Any :doc:`core committer</internals/committers>` may call for a formal vote
  136. using the same voting mechanism above. A proposition will be considered carried
  137. by the core team if:
  138. * There are three "+1" votes from members of the core team.
  139. * There is no "-1" vote from any member of the core team.
  140. * The :ref:`BDFLs<django-bdfls>` haven't stepped in and executed their
  141. positive or negative veto.
  142. When calling for a vote, the caller should specify a deadline by which
  143. votes must be received. One week is generally suggested as the minimum
  144. amount of time.
  145. Since this process allows any core committer to veto a proposal, any "-1"
  146. votes (or BDFL vetos) should be accompanied by an explanation that explains
  147. what it would take to convert that "-1" into at least a "+0".
  148. Whenever possible, these formal votes should be announced and held in
  149. public on the `django-developers`_ mailing list. However, overly sensitive
  150. or contentious issues -- including, most notably, votes on new core
  151. committers -- may be held in private.
  152. .. _searching: http://code.djangoproject.com/search
  153. .. _custom queries: https://code.djangoproject.com/query
  154. .. _django-developers: http://groups.google.com/group/django-developers
  155. .. _django-users: http://groups.google.com/group/django-users
  156. .. _#django: irc://irc.freenode.net/django