summaryrefslogtreecommitdiffstats
path: root/STYLE
blob: 6ef6f147a05a992e559beee7afed06af261becde (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 (particularly exported funtions), and 
  provide a type signature; use Haddock syntax in the comments.

* Follow the coding style of the other modules.

* Code should be compilable with -Wall -Werror. There should be no warnings.

* 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 QuickCheck properties
  precisely defining its behaviour.

* New modules should identify the author, and be submitted under
  the same license as XMonad (BSD3 license or freer).