aboutsummaryrefslogtreecommitdiffstats
path: root/HACKING
blob: 433872104c2422625facb8e8766944fdf6f060b7 (plain) (blame)
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
In order to keep the code nice and clean we have a few requirements you'll
need to stick to in order to get your patch accepted:

- use 8-space tabs for indentation
- curly brackets are on a new line
- please compare with NULL or FALSE isntead of using "!"
- callback functions have a suffix _cb
- all files have to be encoded in UTF-8

  Comment blocks are written like this:
  
/*
 * bla_bla_cb: This is an example comment block
 */

When submitting a patch or committing to cvs do not forget
to write a Changelog entry. Please put both a description
and a reference to the bug (if there is one). Write your entry
using UTF-8 encoding, and make sure your editor doesn't mangle
the encoding of the ChangeLog file.


Example of an entry:

2004-02-19  Christian Persch  <chpe@cvs.gnome.org>
                                                                                                                             
        * lib/egg/egg-toolbar-editor.c: (toolbar_removed_cb),
        (egg_toolbar_editor_set_model), (egg_toolbar_editor_class_init),
        (update_actions_list), (egg_toolbar_editor_load_actions):
        * lib/egg/egg-toolbar-editor.h:
                                                                                                                             
        When removing a toolbar, make its items available again in the toolbar
        editor. (Bug #131182)

Do NOT commit to this module without permission from me 
(marco@gnome.org)