diff options
| author | Hécate Moonlight <hecate+github@glitchbra.in> | 2022-06-21 17:21:08 +0200 |
|---|---|---|
| committer | Hécate Moonlight <hecate+github@glitchbra.in> | 2022-06-21 17:21:08 +0200 |
| commit | 56af824c911c79c508f51103bc3134f98a2133e0 (patch) | |
| tree | ea75468220f515690047b4423e563a37d6ea4671 | |
| parent | 118dd4ed0c901f56070052405f533d9deff5bb22 (diff) | |
Update the contribution guide
| -rw-r--r-- | CONTRIBUTING.md | 10 |
1 files changed, 3 insertions, 7 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 25b7a002..4435252a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,16 +36,13 @@ 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). +Pull requests are to be opened against the `main` branch, from which are forked +GHC-specific branches (like `ghc-9.2`, `ghc-9.4`, etc). ### Building the packages #### Using `cabal` -Requires cabal `>= 3.4` and GHC `== 9.2`: - First update the package list: ```bash @@ -60,7 +57,7 @@ cabal v2-build all --enable-tests cabal v2-test all ``` -### Updating golden testsuite outputs +### Updating golden test suite 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`, @@ -72,6 +69,5 @@ cabal v2-test html-test latex-test hoogle-test hypsrc-test \ --test-option='--accept' ``` - [SSCCE]: http://sscce.org/ [CoC]: ./CODE_OF_CONDUCT.md |