summaryrefslogtreecommitdiffstats
path: root/STYLE
diff options
context:
space:
mode:
authorgwern0 <gwern0@gmail.com>2007-10-24 00:52:25 +0200
committergwern0 <gwern0@gmail.com>2007-10-24 00:52:25 +0200
commit671dd13eb1954f82e3fb4208d9d413605545e6e1 (patch)
treef6ce2058996c106d2def1a989cdd95c6405299d5 /STYLE
parentc172bc9f5fb5d5f7a360588d6860ecd3bbfc91ea (diff)
downloadmetatile-671dd13eb1954f82e3fb4208d9d413605545e6e1.tar
metatile-671dd13eb1954f82e3fb4208d9d413605545e6e1.zip
STYLE: enlarge on existing principles
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? darcs-hash:20071023225225-f7719-b7b58743afb6be87ceda293a8b0f968cabf1da39
Diffstat (limited to 'STYLE')
-rw-r--r--STYLE20
1 files changed, 10 insertions, 10 deletions
diff --git a/STYLE b/STYLE
index 8fa927b..6ef6f14 100644
--- a/STYLE
+++ b/STYLE
@@ -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).