blob: d94d5b78dcf06c55b41d2fd3f54bfd6a88e5b566 (
plain) (
tree)
|
|
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.
- Callback functions have a suffix _cb.
- All files have to be encoded in UTF-8.
- Use char/int/double/..., not gchar/gint/gdouble/... types.
- All implementation files must include first "config.h", followed by
the primary header, followed by a blank line, followed by all the
local headers sorted alphabetically, followed by a blank line,
followed by all the system headers sorted alphabetically.
- Make comments full sentences. This means proper capitalization and
punctuation.
- 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.
|
