~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to docs/contributing/code.rst

  • Committer: Daniel Nichter
  • Date: 2011-10-23 05:45:09 UTC
  • mto: This revision was merged to the branch mainline in revision 2448.
  • Revision ID: daniel@percona.com-20111023054509-5w1z0g4hn1c4guqv
A lot of doc changes: rewrite and expand Configuration and Administration, re-order top-level sections, enhance Contributing, add Release Notes, add Help and Support, fix title casing, label all plugins, other misc. enhancements.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.. _code-label:
 
1
.. _contributing_code:
2
2
 
3
3
Contributing Code
4
4
=================
5
5
 
 
6
We recommend that anyone new to Drizzle who wants to learn the code shoult
 
7
see the
 
8
`Low hanging fruit <https://bugs.launchpad.net/drizzle/+bugs?field.tag=low-hanging-fruit>`_
 
9
list of bugs on Launchpad for possible tasks to take on.
 
10
 
6
11
SSH Keys
7
12
--------
8
13
 
78
83
Test Cases
79
84
----------
80
85
 
 
86
.. program:: test-run
 
87
 
81
88
Where possible, SQL test cases should be created for your code.  Our test cases
82
89
for bug fixes should be in the ``tests/suite/regression`` directory.  For more
83
90
information about creating test cases please see the :ref:`test run <test-run-label>`
84
91
section of our documentation.
85
92
 
 
93
If writing a plugin, the other plugins in trunk have many examples of test cases.
 
94
 
 
95
You should attempt to test your code on multiple platforms before publishing
 
96
it or proposing it for merging.  Your tests must pass on all
 
97
:ref:`supported_platforms` and be idempotent (pass when ran with
 
98
:option:`--repeat-test` 2).  You can test on other platforms by using
 
99
`VirtualBox <https://www.virtualbox.org/>`_ or another virtualization
 
100
server, or by requesting access to the `Drizzle Jenkins server <http://jenkins.drizzle.org/>`_.
 
101
 
86
102
Pushing Work
87
103
------------
88
104
 
94
110
   bzr push lp:~username/drizzle/trunk-bug-NNNNNN
95
111
 
96
112
This will create the branch on Launchpad which you will be able to see on the
97
 
`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
98
 
too.
 
113
`code page <https://code.launchpad.net/drizzle>`_.  If you commit more changes
 
114
to your branch, just ``bzr push`` to publish the new changes.
99
115
 
100
116
Merge Proposals
101
117
---------------
102
118
 
103
 
Once your work is done and ready for review you can go to the
104
 
`code page <https://code.launchpad.net/drizzle>`_, and then click on your branch.
 
119
Once your work is done and ready for review, go to
 
120
`code page <https://code.launchpad.net/drizzle>`_, then click on your branch.
105
121
You will see a link labeled *Propose for merging*.
106
122
 
107
123
In this screen simply fill in what this branch does and click the
108
 
*Propose Merge* button.  Someone will review the branch, usually within a day or
109
 
two. If approved, it will go though our rigourous testing process, which can
 
124
*Propose Merge* button.  Members of the
 
125
`Drizzle merge team <https://launchpad.net/~drizzle-merge>`_
 
126
will review the branch, usually within a few days.
 
127
If approved, it will go though our rigourous testing process, which can
110
128
take several hours.  If it needs more work, feedback will always be given to
111
129
explain why.