Changeset 5488 for django/branches/per-object-permissions/docs/contributing.txt

Timestamp:

06/17/07 17:18:54 (2 years ago)

Author:

clong

Message:

per-object-permissions: Merged to trunk [5486] NOTE: Not fully tested, will be working on this over the next few weeks.

Files:

• django/branches/per-object-permissions/docs/contributing.txt (modified) (11 diffs)

django/branches/per-object-permissions/docs/contributing.txt

@@ -123 +123 @@
-      tracker apply correct syntax highlighting, which is quite helpful.
-
-Put the prefix "[patch] " before the title of your ticket. This will make
-it obvious that the ticket includes a patch, and it will add the ticket
-o t
+Check the "Has patch" box on the ticket details. This will make it
+obvious that the ticket includes a patch, and it will add the ticket to
+
-
-    * The code required to fix a problem or add a feature is an essential part
@@ -152 +152 @@
-don't meet all the requirements of a `good patch`_.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-.. _required details: `Reporting bugs`_
-.. _good patch: `Patch style`_
+.. _patch: `Submitting patches`_
-
-Submitting and maintaining translations
@@ -187 +260 @@
-
-.. _Django i18n mailing list: http://groups.google.com/group/django-i18n/
-http://www.djangoproject.com/documentation
+..
-
-Coding style
@@ -207 +280 @@
-      for details.
-
+    * Please don't put your name in the code you contribute. Our policy is to
+      keep contributors' names in the ``AUTHORS`` file distributed with Django
+      -- not scattered throughout the codebase itself. Feel free to include a
+      change to the ``AUTHORS`` file in your patch if you make more than a
+      single trivial change.
+
+Template style
+--------------
+
-    * In Django template code, put one (and only one) space between the curly
-      brackets and the tag contents.
@@ -218 +300 @@
-          {{foo}}
-
+View style
+----------
+
-    * In Django views, the first parameter in a view function should be called
-      ``request``.
@@ -231 +316 @@
-              # ...
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-Committing code
@@ -312 +460 @@
-how to write new tests.
-
-http://www.djangoproject.com/documentation
+..
-
-Running the unit tests
@@ -322 +470 @@
-
-Yes, the unit tests need a settings module, but only for database connection
-
-
-
-
+
+
+
+
+
-
-The unit tests will not touch your existing databases; they create a new
@@ -439 +588 @@
-change the symlink to point to the old code.
-
+A third option is to use a `path file`_ (``<something>.pth``) which should
+work on all systems (including Windows, which doesn't have symlinks
+available). First, make sure there are no files, directories or symlinks named
+``django`` in your ``site-packages`` directory. Then create a text file named
+``django.pth`` and save it to your ``site-packages`` directory. That file
+should contain a path to your copy of Django on a single line and optional
+comments. Here is an example that points to multiple branches. Just uncomment
+the line for the branch you want to use ('Trunk' in this example) and make
+sure all other lines are commented::
+
+    # Trunk is a svn checkout of:
+    #   http://code.djangoproject.com/svn/django/trunk/
+    #
+    /path/to/trunk
+
+    # <branch> is a svn checkout of:
+    #   http://code.djangoproject.com/svn/django/branches/<branch>/
+    #
+    #/path/to/<branch>
+
+    # On windows a path may look like this:
+    # C:/path/to/<branch>
+
-If you're using Django 0.95 or earlier and installed it using
-``python setup.py install``, you'll have a directory called something like
@@ -445 +617 @@
-file. Then copy the branch's version of the ``django`` directory into
-``site-packages``.
+
+.. _path file: http://docs.python.org/lib/module-site.html
-
-Official releases
@@ -549 +723 @@
-.. _django-users: http://groups.google.com/group/django-users
-.. _`#django`: irc://irc.freenode.net/django
-report/12
+query?status=new&status=assigned&status=reopened&has_patch=1&order=priority
-.. _PEP 8: http://www.python.org/peps/pep-0008.html
-.. _i18n documentation: http://www.djangoproject.com/documentation/i18n/
-.. _i18n branch: http://code.djangoproject.com/browser/django/branches/i18n
-.. _`tags/releases`: http://code.djangoproject.com/browser/django/tags/releases