mirror of
https://github.com/xmonad/xmonad.git
synced 2025-08-03 13:41:54 -07:00
start on style guide
This commit is contained in:
21
STYLE
Normal file
21
STYLE
Normal file
@@ -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.
|
Reference in New Issue
Block a user