12 Commits

Author SHA1 Message Date
Yecine Megdiche
9442871016 CONTRIBUTING: Document expectations about maintenance and getting involved
Related: https://github.com/xmonad/xmonad/issues/341
2022-06-13 11:05:25 +02:00
Tomas Janousek
adb363a480 CONTRIBUTING: Add missing periods
Related: https://github.com/xmonad/xmonad/issues/341
2022-06-13 11:03:28 +02:00
Yecine Megdiche
3d65a37c7e CONTRIBUTING: Drop "Rebasing and Squashing Commits" in favor of online docs
Single-commit pull requests are discouraged by the core team now, so
drop that section and just refer to cbeams a kernel docs instead.

Related: https://github.com/xmonad/xmonad/issues/341
2022-06-13 10:59:41 +02:00
Yecine Megdiche
78f1a8e716 CONTRIBUTING: Drop xmonad-testing
xmonad-testing isn't really being used, so the wording needs to be
changed in CONTRIBUTING.md and in the PR template. The important thing:
we want an example for new modules/functionality, and appropriate tests.

Related: https://github.com/xmonad/xmonad/issues/341
2021-10-27 16:50:10 +01:00
slotThe
a03b6e86de CONTRIBUTING.md: Refer to pedantic
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
2021-10-25 09:14:06 +02:00
slotThe
6608f0012b CONTRIBUTING.md: Mention IRC/matrix before mailing list
Nowadays, the IRC and (since it is linked to it) matrix channels are
much faster ways to get into contact with us than the (very low traffic)
mailing list.  CONTRIBUTING should reflect that, since especially new
contributors might not know where to go to get a feeling for the people
working on the project—or worse, think we only communicate via pull
requests and issues!
2021-10-24 17:43:45 +02:00
slotThe
bc8f7ff133 Move STYLE to CONTRIBUTING.md
Style guidelines should be where most people will see them.  Since we
already ask people to read CONTIRBUTING.md when they submit a pull
request, putting them in there seems like the best place.

We can also drop the curious "or freer" clause from the licensing point,
much like xmonad-contrib@f39218ddb5ffeddce90f620910d5ef2c14f2b43d
already did.
2021-10-24 17:43:45 +02:00
Tomas Janousek
453010bb6d Link to xmonad-docs instead of hackage (fixes some links)
Fixes broken links to X.U.Hacks and X.U.ClickableWorkspaces.
2021-08-07 15:14:12 +01:00
Tomas Janousek
d64a22d8db Switch IRC channel to irc.libera.chat
Since freenode has decided to kick us off because we said that we're
moving to Libera:

    Topic for #xmonad is "This channel has moved to ##xmonad. The topic is in violation of freenode policy: https://freenode.net/policies"
    Topic set by freenodecom (~com@freenode/staff) on Wed, 26 May 2021 04:59:51

it is high time we change the official channel on the website—even
though we don't even have OP on Libera yet.

Related: https://github.com/xmonad/xmonad-web/pull/26/
Co-authored-by: slotThe <soliditsallgood@mailbox.org>
2021-05-26 10:55:52 +01:00
Yecine Megdiche
b59c768cdd
Updated CONTRIBUTING.md and MAINTAINERS.md (#253)
* Updated CONTRIBUTING.md and MAINTAINERS.md

* Fixed broken GitHub links
* Added instructions on how to run tests
* Linked XMonad.Doc.Developing

* updated hackage link
2020-12-15 21:19:07 +05:30
Peter Jones
10b843ad21
Add a section on rebashing and squashing 2017-04-10 16:58:45 -07:00
Peter Jones
f2da028ff9
Add CONTRIBUTING.md and GitHub templates 2017-01-12 12:23:48 -07:00