aboutsummaryrefslogtreecommitdiffstats
path: root/HACKING
blob: a768611d8cecce8b167f7e8e50c0bb3614d51d02 (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
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 2-space no-tabs for indentation (mandatory on new files, old ones will
  be re-indented eventually. When modifying an existing file with 8-space
  indentation keep the old style please)
- Use K&R style for the braces
- No braces for one line control clauses.
- please compare with NULL or FALSE isntead of using "!"
- callback functions have a suffix _cb
- all files have to be encoded in UTF-8
- Use char/int/double/..., not gchar/gint/gdouble/... types.

- data/kr-gnome-indent.cfg is provided as a reference config file for the
  uncrustify program to get correct indentation in new files.

  Comment blocks are written like this:

/*
 * bla_bla_cb: This is an example comment block
 */

See ChangeLog.README for Git checkin rules.
See doc/debugging.txt for some tips and tricks for debugging.

Do NOT commit to this module without permission from a maintainer.
See the MAINTAINERS file for who they are.