summaryrefslogtreecommitdiffstats
path: root/STYLE
diff options
context:
space:
mode:
authorDon Stewart <dons@galois.com>2007-10-24 00:14:22 +0200
committerDon Stewart <dons@galois.com>2007-10-24 00:14:22 +0200
commitc172bc9f5fb5d5f7a360588d6860ecd3bbfc91ea (patch)
tree18370df19756946c76f09432a50b7caa095ca88a /STYLE
parentb0ed373e78a86d1c85cc4ef348a26b7e402d68d1 (diff)
downloadmetatile-c172bc9f5fb5d5f7a360588d6860ecd3bbfc91ea.tar
metatile-c172bc9f5fb5d5f7a360588d6860ecd3bbfc91ea.zip
start on style guide
darcs-hash:20071023221422-cba2c-c25fffc1e028f8fea59004e20a24f3ed97029895
Diffstat (limited to 'STYLE')
-rw-r--r--STYLE21
1 files changed, 21 insertions, 0 deletions
diff --git a/STYLE b/STYLE
new file mode 100644
index 0000000..8fa927b
--- /dev/null
+++ b/STYLE
@@ -0,0 +1,21 @@
+
+== Coding guidelines for contributing to
+== xmonad and the xmonad contributed extensions
+
+* Comment every top level function, and provide a type signature, using
+ haddock syntax.
+
+* Follow the coding style of already existing modules
+
+* Code should be compiled with -Wall and emit no errors
+
+* Partial functions should be avoided: the window manager should not
+ crash, so do not call `error` or `undefined`
+
+* Tabs are illegal. Use 4 spaces for indenting
+
+* Any pure function added to the core should have a QuickCheck property
+ defining its behaviour
+
+* New modules should identify the author, and have are submitted under
+ the xmonad BSD3 license.