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

CONTRIBUTING.md: Refer to pedantic

Browse Source 
Instead of manually compiling with `-Wall -Werror` and the like, we have
a `pedantic` flag in xmonad's cabal file with which to run the CI.
Since contributors are very unlikely to not use either stack or cabal to
build xmonad, we should refer them to this flag instead of listing all
of the options they would need to compile xmonad with in order to check
their work.

Fixes: bc8f7ff133e6a5415fd831c3ab232199ab462800
This commit is contained in:
slotThe 2021-10-25 09:09:22 +02:00
parent 856c8b2c8d
commit a03b6e86de
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@ -72,7 +72,7 @@ Here are some tips for getting your changes merged into xmonad:
* Make sure you read the section on rebasing and squashing commits
below.
## Style guidelines
## Style Guidelines
Below are some common style guidelines that all of the core modules
follow. Before submitting a pull request, make sure that your code does
@ -84,9 +84,11 @@ as well!
* Follow the coding style of the module that you are making changes to
(`n` spaces for indentation, where to break long type signatures, …)
* New code should not introduce any new warnings. If you don't
compile your changes via stack or cabal, make sure to compile with
`-Wall -Werror -fno-warn-unused-do-bind -fwarn-tabs`.
* New code should not introduce any new warnings. If you want to
check this yourself before submitting a pull request, there is the
`pedantic` flag, which is enforced in our CI. You can enable it by
building your changes with `stack build --flag xmonad:pedantic` or
`cabal build --flag pedantic`.
* Likewise, your code should be free of [hlint] warnings; this is also
enforced in our GitHub CI.