twin/xmonad
1
0
Fork 0
mirror of https://github.com/xmonad/xmonad.git synced 2025-08-01 04:31:53 -07:00
Code Issues Packages Projects Releases Wiki Activity

STYLE: enlarge on existing principles

Browse Source 
Comments: the -Wall thing was just trying to say -Wall -Werror should work. The license thing was too narrow - or are my public domain contributions unwelcome because they are not BSD-3? I think comments are most important for exported functions users will use; it isn't so important for helper functions (used only in the module) to be very well-documented, right?
This commit is contained in:
gwern0
2007-10-23 22:52:25 +00:00
parent 1ddaffbfba
commit 350a4d6f6b
1 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
STYLE
View File

@@ -1,21 +1,21 @@
== Coding guidelines for contributing to
== xmonad and the xmonad contributed extensions
== XMonad and the XMonad contributed extensions
* Comment every top level function, and provide a type signature, using
haddock syntax.
* Comment every top level function (particularly exported funtions), and
provide a type signature; use Haddock syntax in the comments.
* Follow the coding style of already existing modules
* Follow the coding style of the other modules.
* Code should be compiled with -Wall and emit no errors
* 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
* Tabs are illegal. Use 4 spaces for indenting.
* Any pure function added to the core should have a QuickCheck property
defining its behaviour
* Any pure function added to the core should have QuickCheck properties
precisely defining its behaviour.
* New modules should identify the author, and have are submitted under
the xmonad BSD3 license.
* New modules should identify the author, and be submitted under
the same license as XMonad (BSD3 license or freer).