Skip to content

Latest commit

 

History

History
72 lines (46 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

72 lines (46 loc) · 1.74 KB

Contributing to Haddock

Thank you for contributing to Haddock! Here is the information you will need in order to make your contribution

Reporting issues

Please open a ticket if you get an unexpected behaviour from Haddock!
You should ideally include a Short, Self Contained, Correct (Compilable), Example in your ticket, so that the maintainers may easily reproduce your issue.

Here is a list of things you should include in your ticket

  • Your GHC version.

  • Your platform, OS and distribution if applicable.

  • Your cabal version if applicable.

  • Include any other info you think might be relevant (sandbox? unusual setup?).

Hacking

To get started you'll need the latest GHC release installed.

Clone the repository:

git clone https://github.com/haskell/haddock.git
cd haddock

Git Branches

For improvements to the documentation generator, please base your pull request on the latest GHC version branch (ghc-9.2 for instance).

Building the packages

Using cabal

Requires cabal >= 3.4 and GHC == 9.2:

First update the package list:

cabal v2-update

This is needed as [email protected] uses the ghc.head package repository.

cabal v2-build all --enable-tests
cabal v2-test all

Updating golden testsuite outputs

If you've changed Haddock's output, you will probably need to accept the new output of Haddock's golden test suites (html-test, latex-test, hoogle-test, and hypsrc-test). This can be done by passing the --accept argument to these test suites. With a new enough version of cabal-install:

cabal v2-test html-test latex-test hoogle-test hypsrc-test \
  --test-option='--accept'