mirror of
https://github.com/xmonad/xmonad.git
synced 2025-08-01 04:31:53 -07:00
350a4d6f6b
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?
22 lines
751 B
Plaintext
22 lines
751 B
Plaintext
|
|
== 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).
|