How to change GHC's documentation
GHC runs on GitLab: https://gitlab.haskell.org/ghc/ghc
Small changes only change comments, not code. Limited to one file.
The continuous integration testing also has slow turnaround. Make sure not to add trailing whitespace :) but don't be afraid to submit fixes. We appreciate your contribution.
The simplest way to contribute patches is using the GitLab web interface. To write a patch for
Control.Monad you would go to
libraries/base/Control/Monad.hs where the Edit button takes you to an online editor:
Change the documentation, write a descriptive commit message and Commit changes.
This takes you to New Merge Request: Follow the instructions and finally Submit merge request.
Updating GHC's documentation is easy, and can benefit newcomers greatly!
GHC's documentation is included within in its source code, using Haddock's markup.
Here are the steps to modify it:
- Create a Merge Request on GitLab.
- Wait for the reviewers to look at your patches. If this takes more than a week, complain!
Wait for bgamari to publish the documentation. (As of Nov 2017, he runs the publish script manually, about once a month.) If this takes more than a month, complain on the
#ghcchannel on FreeNode!
Then have a beer on us. We are truly grateful.