← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to docs/contributing/code.rst

  • Committer: Monty Taylor
  • Date: 2011-03-10 18:18:24 UTC
  • mfrom: (2222.2.1 drizzle)
  • mto: This revision was merged to the branch mainline in revision 2228.
  • Revision ID: mordred@inaugust.com-20110310181824-mv5zqrahenb62y5i
Merge Mark: Documentation Edits

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/contributing/code.rst
14
14
 #. Paste your public key into the text box and click the *Import public key*
15
15
    button
16
16
 
 
17
Logging into Launchpad
 
18
----------------------
 
19
 
 
20
You will need to set up your local bzr configuration with your Launchpad account
 
21
so that you can push branches for merging.  To do this:
 
22
 
 
23
 # bzr launchpad-login username
 
24
 
17
25
Getting the Code
18
26
----------------
19
27
 
20
 
You will need to prepare a directory for working with Drizzle, the following
 
28
You will need to prepare a directory for working with Drizzle. The following
21
29
example will assume you want to do this in ~/repos/drizzle:
22
30
 
23
31
.. code-block:: bash
26
34
   cd ~/repos
27
35
   bzr init-repo drizzle
28
36
 
29
 
At this stage you now have an initialized a directory for bzr to use.  Revision
30
 
data will be stored here to save it having to be downloaded/stored for every
31
 
branch.
 
37
At this stage you now have an initialized a directory named ~/repos/drizzle
 
38
for bzr to use.  Revision data will be stored in this directory so that it
 
39
does not have to be separately downloaded and stored for every branch.
32
40
 
33
41
.. code-block:: bash
34
42
 
49
57
---------------
50
58
 
51
59
All commits need to have a proper description of the changes made.  This is so
52
 
that future developers can dig through the bzr log to find out why a certain
 
60
that future developers can read through the bzr log to find out why a certain
53
61
change happened.
54
62
 
55
63
When committing a bug fix please use:
64
72
Coding Standards
65
73
----------------
66
74
 
67
 
Our coding standards can be found inside the
 
75
Our coding standards can be found at the
68
76
`Drizzle wiki <http://wiki.drizzle.org/Coding_Standards>`_.
69
77
 
70
78
Test Cases
71
79
----------
72
80
 
73
 
Where possible SQL test cases should be created for your code.  Our test cases
 
81
Where possible, SQL test cases should be created for your code.  Our test cases
74
82
for bug fixes should be in the ``tests/suite/regression`` directory.  For more
75
83
information about creating test cases please see the :ref:`test run <test-run-label>`
76
84
section of our documentation.
93
101
---------------
94
102
 
95
103
Once your work is done and ready for review you can go to the
96
 
`code page <https://code.launchpad.net/drizzle>`_, click on your branch and you
97
 
will see a link saying *Propose for merging*.
 
104
`code page <https://code.launchpad.net/drizzle>`_, and then click on your branch.
 
105
You will see a link labeled *Propose for merging*.
98
106
 
99
107
In this screen simply fill in what this branch does and click the
100
108
*Propose Merge* button.  Someone will review the branch, usually within a day or
101
 
two and if approved it will go though our rigourous testing process which can
102
 
take several hours.  If it needs more work feedback will always be given to
 
109
two. If approved, it will go though our rigourous testing process, which can
 
110
take several hours.  If it needs more work, feedback will always be given to
103
111
explain why.