Changes between Version 1 and Version 2 of PatchGuidelines


Ignore:
Timestamp:
11/28/2005 09:35:40 AM (9 years ago)
Author:
jacob
Comment:

Replaced this wiki page with the section from the "contributing" document

Legend:

Unmodified
Added
Removed
Modified
  • PatchGuidelines

    v1 v2  
    11= Patch guidelines =
    22
    3 We're very grateful for patches to Django's code. A patch is a file, or collection of files, that describes how to change Django's source code or documentation to fix bugs, add features or improve the framework in any other way.
    4 
    5 This document gives some brief, but important, guidelines for submitting patches.
    6 
    7 == Patch style ==
    8 
    9  * Submit patches in the format returned by the {{{svn diff}}} command. An exception is for code changes that are described more clearly in plain English than in code. Indentation is the most common example; it's hard to read patches when the only difference in code is that it's indented.
    10 
    11  * Attach patches to the appropriate ticket in the [http://code.djangoproject.com/report Django ticket system], using the "Attach file" button.
    12 
    13 == Code style ==
    14 
    15 Please follow these Python style guidelines when submitting patches:
    16 
    17  * Use four spaces to indent.
    18 
    19  * Follow the "Whitespace in Expressions and Statements" guidelines of [http://www.python.org/peps/pep-0008.html PEP 8].
    20 
    21  * Use underscores, not camelCase, for variable, function and method names.
    22 
    23  * Use {{{InitialCaps}}} for class names.
    24 
     3See http://www.djangoproject.com/documentation/contributing/#patch-style
Back to Top