diff options
| author | Hécate Moonlight <hecate+github@glitchbra.in> | 2021-02-05 19:06:56 +0100 |
|---|---|---|
| committer | Hécate Moonlight <hecate+github@glitchbra.in> | 2021-02-05 19:09:38 +0100 |
| commit | 483642b53b49c622a3f94cc05235c7a618d2e7d7 (patch) | |
| tree | eab4aed89061f14c02aad12bfa8e9d2c422b929b | |
| parent | 66035bc2e0f6ba66efc22d048208affd8aef33c4 (diff) | |
Amend the CONTRIBUTING.md file
| -rw-r--r-- | CONTRIBUTING | 17 | ||||
| -rw-r--r-- | CONTRIBUTING.md | 18 |
2 files changed, 16 insertions, 19 deletions
diff --git a/CONTRIBUTING b/CONTRIBUTING deleted file mode 100644 index 45f74789..00000000 --- a/CONTRIBUTING +++ /dev/null @@ -1,17 +0,0 @@ -If you're filing an issue, here are the things which will help us a lot: - -* State your GHC version. - -* State your platform, OS and distribution if applicable. - -* State your cabal version if applicable. - -* Tell us how to replicate the problem. If we can't replicate it, we - can't fix it. - -* If the problem involves running Haddock on some source, please - include the sample on which we can replicate, the smaller/cleaner - the better. Include some images if you think it will help us. - -* Include any other info you think might be relevant (sandbox? unusual - setup?). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6a396c41..1e1aeca6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,6 +9,16 @@ Please open a ticket if you get an unexpected behaviour from Haddock! You should ideally include a [Short, Self Contained, Correct (Compilable), Example][SSCCE] 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. @@ -22,9 +32,13 @@ cd haddock ### Git Branches -Please **always** base your pull request on the current GHC version branch +If your patch consists of glue code and interface changes with GHC, please +open a Pull Request targeting the `ghc-head` branch. + +Otherwise, for improvements to the documentation generator, +please base your pull request on the current GHC version branch (`ghc-9.0` for instance). The PR will be forward-ported to `ghc-head` -so that GHC can use it. +so that documentation built within GHC can benefit from it. ### Building the packages |