From ad70509fbb5e32ff092e4054ce1945f889939fb8 Mon Sep 17 00:00:00 2001
From: =?utf8?q?Jos=C3=A9=20Fonseca?= <jose.r.fonseca@gmail.com>
Date: Wed, 26 Oct 2011 23:02:08 +0100
Subject: [PATCH 1/1] Document coding syntax, and other development practices.

---
 DEVELOPMENT.markdown | 78 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 78 insertions(+)
 create mode 100644 DEVELOPMENT.markdown

diff --git a/DEVELOPMENT.markdown b/DEVELOPMENT.markdown
new file mode 100644
index 0000000..b64db14
--- /dev/null
+++ b/DEVELOPMENT.markdown
@@ -0,0 +1,78 @@
+Coding Style
+============
+
+XXX: These are guidelines for new code. Some of existing hasn't been updated
+to these conventions yet.
+
+Whitespace (all languages):
+
+ * indentation is 4 spaces
+
+ * never use tabs as indents
+
+ * otherwise tab equals to 8 spaces
+
+ * separate classes with two empty lines
+
+Naming convention:
+
+ * camelCase for functions/methods
+
+ * UpperCase for structures/classes
+
+ * lowercase for namespaces/modules
+
+ * `UPPER_CASE` for #defines
+
+C++:
+
+ * enclose single statement `if` clauses in { }, specially for automatically
+   generated code
+
+ * } else {
+
+ * use inlines for functions/methods which are called with high-frequency
+
+CMake:
+
+ * `lower_case`
+
+ * space between ( and precedent name
+
+
+When in doubt, be consistent with the existing code.
+
+
+Commit policy
+=============
+
+Feature development:
+
+* Existing features in master branch should not degrade at any time, for any
+  platform.  (Unless it is not widely used and there is agreement.)
+
+* It's fine to add new features for only some platforms.
+
+* Non-trivial changes should be staged in a branch, to enable peer-review and
+  regression testing.  Branch should be deleted once code has been merged.
+
+* Releases are tagged commits from master.  There are no stable branches.
+
+
+Backwards compatibility:
+
+* Backwards binary compatibility with old traces must be always maintained: all
+  tools, including glretrace, must handle old traces without regressions.
+
+* No backwards compatibility guarantees for derived data (ASCII dumps, state,
+  images, etc).
+
+* There should be no gratuitous change to command line tool interfaces, but no
+  guarantees are given.
+
+
+
+Regression testing
+==================
+
+Not standardized yet.  Work in progress.
-- 
2.43.0