1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
.. _code-label:
Contributing Code
=================
SSH Keys
--------
You will need to add a public SSH key to Launchpad to be able to push branches
up for merging. To do this:
#. Generate an SSH key (information on how to do this is in `Launchpad's help pages <https://help.launchpad.net/YourAccount/CreatingAnSSHKeyPair>`_)
#. Go to `your SSH keys page <https://launchpad.net/people/+me/+editsshkeys>`_
#. Paste your public key into the text box and click the *Import public key*
button
Logging into Launchpad
----------------------
You will need to set up your local bzr configuration with your Launchpad account
so that you can push branches for merging. To do this:
# bzr launchpad-login username
Getting the Code
----------------
You will need to prepare a directory for working with Drizzle. The following
example will assume you want to do this in ~/repos/drizzle:
.. code-block:: bash
mkdir ~/repos
cd ~/repos
bzr init-repo drizzle
At this stage you now have an initialized a directory named ~/repos/drizzle
for bzr to use. Revision data will be stored in this directory so that it
does not have to be separately downloaded and stored for every branch.
.. code-block:: bash
cd drizzle
bzr branch lp:drizzle trunk
This will take a little while, it is getting all the revisions since the
beginning of the repository. This should only ever need to be done once though.
.. code-block:: bash
bzr branch trunk drizzle-bug-NNNNNN
cd drizzle-bug-NNNNNN
This creates a branch from trunk for you to work on.
Committing Work
---------------
All commits need to have a proper description of the changes made. This is so
that future developers can read through the bzr log to find out why a certain
change happened.
When committing a bug fix please use:
.. code-block:: bash
bzr commit --fixes lp:NNNNNN
This will automatically attach the branch to the bug report when the branch is
pushed up.
Coding Standards
----------------
Our coding standards can be found at the
`Drizzle wiki <http://wiki.drizzle.org/Coding_Standards>`_.
Test Cases
----------
Where possible, SQL test cases should be created for your code. Our test cases
for bug fixes should be in the ``tests/suite/regression`` directory. For more
information about creating test cases please see the :ref:`test run <test-run-label>`
section of our documentation.
Pushing Work
------------
When you want to push your branch to Launchpad for others to see or for merging
you can use:
.. code-block:: bash
bzr push lp:~username/drizzle/trunk-bug-NNNNNN
This will create the branch on Launchpad which you will be able to see on the
`code page <https://code.launchpad.net/drizzle>`_. If you make some more commits you simply need to do just ``bzr push`` to get those revisions on Launchpad
too.
Merge Proposals
---------------
Once your work is done and ready for review you can go to the
`code page <https://code.launchpad.net/drizzle>`_, and then click on your branch.
You will see a link labeled *Propose for merging*.
In this screen simply fill in what this branch does and click the
*Propose Merge* button. Someone will review the branch, usually within a day or
two. If approved, it will go though our rigourous testing process, which can
take several hours. If it needs more work, feedback will always be given to
explain why.
|