summaryrefslogtreecommitdiff
path: root/docs/internals/contributing
diff options
context:
space:
mode:
authorAndrew Godwin <andrew@aeracode.org>2012-10-26 08:41:13 +0100
committerAndrew Godwin <andrew@aeracode.org>2012-10-26 08:41:13 +0100
commit6a632e04578776e877adc5e2dc53f008c890a0d4 (patch)
treeaa47200fb63adf44609066a45601bd3b8768ec1c /docs/internals/contributing
parenta589fdff81ab36c57ff0a1003e60ee0dd55f3a88 (diff)
parentfabe9c9e5f0a437b5389faaf469ce53091abd3cf (diff)
Merge branch 'master' into schema-alteration
Conflicts: django/db/backends/__init__.py django/db/models/fields/related.py django/db/models/options.py
Diffstat (limited to 'docs/internals/contributing')
-rw-r--r--docs/internals/contributing/committing-code.txt10
-rw-r--r--docs/internals/contributing/localizing.txt2
-rw-r--r--docs/internals/contributing/triaging-tickets.txt9
-rw-r--r--docs/internals/contributing/writing-code/coding-style.txt6
-rw-r--r--docs/internals/contributing/writing-code/unit-tests.txt20
-rw-r--r--docs/internals/contributing/writing-documentation.txt5
6 files changed, 36 insertions, 16 deletions
diff --git a/docs/internals/contributing/committing-code.txt b/docs/internals/contributing/committing-code.txt
index d36bc78fe1..67dda02f8b 100644
--- a/docs/internals/contributing/committing-code.txt
+++ b/docs/internals/contributing/committing-code.txt
@@ -187,7 +187,15 @@ Django's Git repository:
For the curious, we're using a `Trac plugin`_ for this.
- .. _Trac plugin: https://github.com/aaugustin/trac-github
+.. note::
+
+ Note that the Trac integration doesn't know anything about pull requests.
+ So if you try to close a pull request with the phrase "closes #400" in your
+ commit message, GitHub will close the pull request, but the Trac plugin
+ will also close the same numbered ticket in Trac.
+
+
+.. _Trac plugin: https://github.com/aaugustin/trac-github
* If your commit references a ticket in the Django `ticket tracker`_ but
does *not* close the ticket, include the phrase "Refs #xxxxx", where "xxxxx"
diff --git a/docs/internals/contributing/localizing.txt b/docs/internals/contributing/localizing.txt
index 263087b5fa..0cde77882c 100644
--- a/docs/internals/contributing/localizing.txt
+++ b/docs/internals/contributing/localizing.txt
@@ -55,7 +55,7 @@ The format files aren't managed by the use of Transifex. To change them, you
must :doc:`create a patch<writing-code/submitting-patches>` against the
Django source tree, as for any code change:
-* Create a diff against the current Subversion trunk.
+* Create a diff against the current Git master branch.
* Open a ticket in Django's ticket system, set its ``Component`` field to
``Translations``, and attach the patch to it.
diff --git a/docs/internals/contributing/triaging-tickets.txt b/docs/internals/contributing/triaging-tickets.txt
index ab879e5caf..84f70fd731 100644
--- a/docs/internals/contributing/triaging-tickets.txt
+++ b/docs/internals/contributing/triaging-tickets.txt
@@ -171,15 +171,6 @@ concrete actionable issues. They are enhancement requests that we might
consider adding someday to the framework if an excellent patch is submitted.
These tickets are not a high priority.
-Fixed on a branch
-~~~~~~~~~~~~~~~~~
-
-Used to indicate that a ticket is resolved as part of a major body of work
-that will eventually be merged to trunk. Tickets in this stage generally
-don't need further work. This may happen in the case of major
-features/refactors in each release cycle, or as part of the annual Google
-Summer of Code efforts.
-
Other triage attributes
-----------------------
diff --git a/docs/internals/contributing/writing-code/coding-style.txt b/docs/internals/contributing/writing-code/coding-style.txt
index 2fa0233e3d..a699e39bd8 100644
--- a/docs/internals/contributing/writing-code/coding-style.txt
+++ b/docs/internals/contributing/writing-code/coding-style.txt
@@ -140,9 +140,9 @@ Model style
a tuple of tuples, with an all-uppercase name, either near the top of
the model module or just above the model class. Example::
- GENDER_CHOICES = (
- ('M', 'Male'),
- ('F', 'Female'),
+ DIRECTION_CHOICES = (
+ ('U', 'Up'),
+ ('D', 'Down'),
)
Use of ``django.conf.settings``
diff --git a/docs/internals/contributing/writing-code/unit-tests.txt b/docs/internals/contributing/writing-code/unit-tests.txt
index 4de506a654..a828b06b36 100644
--- a/docs/internals/contributing/writing-code/unit-tests.txt
+++ b/docs/internals/contributing/writing-code/unit-tests.txt
@@ -163,6 +163,26 @@ associated tests will be skipped.
.. _gettext: http://www.gnu.org/software/gettext/manual/gettext.html
.. _selenium: http://pypi.python.org/pypi/selenium
+Code coverage
+~~~~~~~~~~~~~
+
+Contributors are encouraged to run coverage on the test suite to identify areas
+that need additional tests. The coverage tool installation and use is described
+in :ref:`testing code coverage<topics-testing-code-coverage>`.
+
+To run coverage on the Django test suite using the standard test settings::
+
+ coverage run ./runtests.py --settings=test_sqlite
+
+After running coverage, generate the html report by running::
+
+ coverage html
+
+When running coverage for the Django tests, the included ``.coveragerc``
+settings file defines ``coverage_html`` as the output directory for the report
+and also excludes several directories not relevant to the results
+(test code or external code included in Django).
+
.. _contrib-apps:
Contrib apps
diff --git a/docs/internals/contributing/writing-documentation.txt b/docs/internals/contributing/writing-documentation.txt
index c8d7039a68..469f8614b9 100644
--- a/docs/internals/contributing/writing-documentation.txt
+++ b/docs/internals/contributing/writing-documentation.txt
@@ -30,8 +30,9 @@ If you'd like to start contributing to our docs, get the development version of
Django from the source code repository
(see :ref:`installing-development-version`). The development version has the
latest-and-greatest documentation, just as it has latest-and-greatest code.
-Generally, we only revise documentation in the development version, as our
-policy is to freeze documentation for existing releases (see
+We also backport documentation fixes and improvements, at the discretion of the
+committer, to the last release branch. That's because it's highly advantageous
+to have the docs for the last release be up-to-date and correct (see
:ref:`differences-between-doc-versions`).
Getting started with Sphinx