~ubuntu-branches/ubuntu/quantal/python-django/quantal-security

« back to all changes in this revision

Viewing changes to docs/internals/contributing.txt

  • Committer: Bazaar Package Importer
  • Author(s): Jamie Strandboge
  • Date: 2010-10-12 11:34:35 UTC
  • mfrom: (1.1.12 upstream) (29.1.1 maverick-security)
  • Revision ID: james.westby@ubuntu.com-20101012113435-yy57c8tx6g9anf3e
Tags: 1.2.3-1ubuntu0.1
* SECURITY UPDATE: XSS in CSRF protections. New upstream release
  - CVE-2010-3082
* debian/patches/01_disable_url_verify_regression_tests.diff:
  - updated to disable another test that fails without internet connection
  - patch based on work by Kai Kasurinen and Krzysztof Klimonda
* debian/control: don't Build-Depends on locales-all, which doesn't exist
  in maverick

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.. _internals-contributing:
2
 
 
3
1
======================
4
2
Contributing to Django
5
3
======================
42
40
help in keeping our ticket tracker as useful as possible is appreciated.  In
43
41
particular:
44
42
 
45
 
    * **Do** read the :ref:`FAQ <faq-index>` to see if your issue might be a well-known question.
 
43
    * **Do** read the :doc:`FAQ </faq/index>` to see if your issue might be a well-known question.
46
44
 
47
45
    * **Do** `search the tracker`_ to see if your issue has already been filed.
48
46
 
145
143
    * Claim the ticket by clicking the radio button next to "Accept ticket"
146
144
      near the bottom of the page, then clicking "Submit changes."
147
145
 
 
146
If you have an account but have forgotten your password, you can reset it
 
147
using the `password reset page`_.
 
148
 
148
149
.. _Create an account: http://www.djangoproject.com/accounts/register/
 
150
.. _password reset page: http://www.djangoproject.com/accounts/password/reset/
149
151
 
150
152
Ticket claimers' responsibility
151
153
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
394
396
are internationalized. This means they display different text depending on a
395
397
user's language setting. For this, Django uses the same internationalization
396
398
infrastructure available to Django applications described in the
397
 
:ref:`i18n documentation<topics-i18n>`.
 
399
:doc:`i18n documentation</topics/i18n/index>`.
398
400
 
399
401
These translations are contributed by Django users worldwide. If you find an
400
402
incorrect translation, or if you'd like to add a language that isn't yet
405
407
    * Make sure you read the notes about :ref:`specialties-of-django-i18n`.
406
408
 
407
409
    * Create translations using the methods described in the
408
 
      :ref:`localization documentation <topics-i18n-localization>`. For this
 
410
      :doc:`localization documentation </topics/i18n/localization>`. For this
409
411
      you will use the ``django-admin.py makemessages`` tool. In this
410
412
      particular case it should be run from the top-level ``django`` directory
411
413
      of the Django source tree.
531
533
    * Use ``InitialCaps`` for class names (or for factory functions that
532
534
      return classes).
533
535
 
534
 
    * Mark all strings for internationalization; see the :ref:`i18n
535
 
      documentation <topics-i18n>` for details.
 
536
    * Mark all strings for internationalization; see the :doc:`i18n
 
537
      documentation </topics/i18n/index>` for details.
536
538
 
537
539
    * In docstrings, use "action words" such as::
538
540
 
694
696
should use the ".. versionchanged:: X.Y" directive (with the same format as the
695
697
``versionadded`` mentioned above.
696
698
 
697
 
There's a full page of information about the :ref:`Django documentation
698
 
system <internals-documentation>` that you should read prior to working on the
 
699
There's a full page of information about the :doc:`Django documentation
 
700
system </internals/documentation>` that you should read prior to working on the
699
701
documentation.
700
702
 
701
703
Guidelines for ReST files
825
827
We appreciate any and all contributions to the test suite!
826
828
 
827
829
The Django tests all use the testing infrastructure that ships with Django for
828
 
testing applications. See :ref:`Testing Django applications <topics-testing>`
 
830
testing applications. See :doc:`Testing Django applications </topics/testing>`
829
831
for an explanation of how to write new tests.
830
832
 
831
833
Running the unit tests
1013
1015
       public, please add the branch to the `Django branches`_ wiki page.
1014
1016
 
1015
1017
    2. Feature branches using SVN have a higher bar. If you want a branch in SVN
1016
 
       itself, you'll need a "mentor" among the :ref:`core committers
1017
 
       <internals-committers>`. This person is responsible for actually creating
 
1018
       itself, you'll need a "mentor" among the :doc:`core committers
 
1019
       </internals/committers>`. This person is responsible for actually creating
1018
1020
       the branch, monitoring your process (see below), and ultimately merging
1019
1021
       the branch into trunk.
1020
1022