| 1 | Hacking ORBit2
|
|---|
| 2 | ==============
|
|---|
| 3 |
|
|---|
| 4 | Please log all patches/bug-reports bugzilla.gnome.org and get
|
|---|
| 5 | approval from myself (Mark) or Michael before committing.
|
|---|
| 6 |
|
|---|
| 7 | If you don't think bugzilla is appropriate, send a mail to
|
|---|
| 8 | orbit-list@gnome.org.
|
|---|
| 9 |
|
|---|
| 10 | If you don't receive any feedback within a resonable number of
|
|---|
| 11 | weeks, go ahead and commit, but please CC the list as you commit.
|
|---|
| 12 |
|
|---|
| 13 | Mark McLoughlin - 19/09/2001
|
|---|
| 14 |
|
|---|
| 15 | Coding Style
|
|---|
| 16 | ============
|
|---|
| 17 |
|
|---|
| 18 | No code that does not work is accepted into ORBit2 - ie. the
|
|---|
| 19 | half finished feature you meant to implement - it's not going in. We
|
|---|
| 20 | have enough unused clutter without more.
|
|---|
| 21 |
|
|---|
| 22 | Code that gets committed must be correct, it must look
|
|---|
| 23 | beautiful, it must have an elegant control flow, it should have
|
|---|
| 24 | complete regression tests that couple to make check - to prove that it
|
|---|
| 25 | works.
|
|---|
| 26 |
|
|---|
| 27 | Indentations are 8 stops, as are tabs. Code layout should use
|
|---|
| 28 | K&R - and distribute the extra whitespace to make the code pleasant to
|
|---|
| 29 | read. Methods should be short, use _ naming not stdlycaps and be sweet
|
|---|
| 30 | - not try to do too many things.
|
|---|
| 31 |
|
|---|
| 32 | Patches should be in diff -u format, and come complete with a
|
|---|
| 33 | dated ChangeLog in the standard form ( cf. emacs C-x 4-a ).
|
|---|
| 34 |
|
|---|
| 35 | Michael Meeks - 9/10/2001
|
|---|
| 36 |
|
|---|
| 37 | Build sheriff commits are welcome - in accordance with the
|
|---|
| 38 | relevant build sheriff constraints.
|
|---|
| 39 |
|
|---|
| 40 | Members of the GNOME packaging product may commit fixes to
|
|---|
| 41 | the .spec files.
|
|---|
