twin/xmonad-contrib
1
0
Fork 0
mirror of https://github.com/xmonad/xmonad-contrib.git synced 2025-05-19 11:30:22 -07:00
Code Issues Packages Projects Releases Wiki Activity

X.D.Developing: Refer to CONTRIBUTING for style

Browse Source 
The CONTRIBUTING.md file for xmonad now has style guidelines [1].  Since
X.D.Developing does not add anything new here and we direct new
contributors to CONTRIBUTING.md anyways, simply refer to the relevant
section.

[1]: bc8f7ff133
This commit is contained in:
slotThe 2021-10-25 12:37:16 +02:00
parent 5d9a599c9f
commit bc5d4f18e2
1 changed files with 3 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
XMonad/Doc/Developing.hs
View File

@ -249,29 +249,9 @@ to do
{- $style {- $style
These are the coding guidelines for contributing to xmonad and the For coding style guidelines while contributing, please see the
xmonad contributed extensions. <https://github.com/xmonad/xmonad/blob/master/CONTRIBUTING.md#style-guidelines style guidelines>
of xmonad's CONTRIBUTING.md.
* Comment every top level function (particularly exported funtions), and
provide a type signature.
* Use Haddock syntax in the comments (see below).
* Follow the coding style of the other modules.
* Code should be compilable with "ghc-options: -Wall -Werror" set in the
xmonad-contrib.cabal file. There should be no warnings.
* Code should be free of any warnings or errors from the Hlint tool; use your
best judgement on some warnings like eta-reduction or bracket removal, though.
* Partial functions should be avoided: the window manager should not
crash, so never call 'error' or 'undefined'.
* Tabs are /illegal/. Use 4 spaces for indenting.
* Any pure function added to the core must have QuickCheck properties
precisely defining its behaviour. Tests for everything else are encouraged.
For examples of Haddock documentation syntax, have a look at For examples of Haddock documentation syntax, have a look at
<https://haskell-haddock.readthedocs.io/en/latest/markup.html its documentation> <https://haskell-haddock.readthedocs.io/en/latest/markup.html its documentation>