twin/xmonad
1
0
Fork 0
mirror of https://github.com/xmonad/xmonad.git synced 2025-07-26 09:41:53 -07:00
Code Issues Packages Projects Releases Wiki Activity

start on style guide

Browse Source
This commit is contained in:
Don Stewart
2007-10-23 22:14:22 +00:00
parent 0903c76d40
commit 1ddaffbfba
1 changed files with 21 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
STYLE Normal file
View 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.