summaryrefslogtreecommitdiffstats
path: root/STYLE
blob: 8fa927b0bde76afbc6997c903b69bed2f81600a6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
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.