aboutsummaryrefslogtreecommitdiffstats
path: root/HACKING
diff options
context:
space:
mode:
Diffstat (limited to 'HACKING')
-rw-r--r--HACKING16
1 files changed, 13 insertions, 3 deletions
diff --git a/HACKING b/HACKING
index d94d5b78d..0dce01dd9 100644
--- a/HACKING
+++ b/HACKING
@@ -1,18 +1,28 @@
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 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.
+
+ Headers should follow the same pattern excluding the config.h and
+ self file section, for obvious reasons.
+
- Make comments full sentences. This means proper capitalization and
punctuation.