Skip to content
This repository was archived by the owner on Aug 3, 2024. It is now read-only.

Commit a2f9f29

Browse files
authored
Merge pull request #1313 from Kleidukos/amend-contributing
Amend the CONTRIBUTING.md file
2 parents 66035bc + 483642b commit a2f9f29

File tree

2 files changed

+16
-19
lines changed

2 files changed

+16
-19
lines changed

CONTRIBUTING

Lines changed: 0 additions & 17 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,16 @@ Please open a ticket if you get an unexpected behaviour from Haddock!
99
You should ideally include a [Short, Self Contained, Correct (Compilable), Example][SSCCE]
1010
in your ticket, so that the maintainers may easily reproduce your issue.
1111

12+
Here is a list of things you should include in your ticket
13+
14+
* Your GHC version.
15+
16+
* Your platform, OS and distribution if applicable.
17+
18+
* Your cabal version if applicable.
19+
20+
* Include any other info you think might be relevant (sandbox? unusual setup?).
21+
1222
## Hacking
1323

1424
To get started you'll need the latest GHC release installed.
@@ -22,9 +32,13 @@ cd haddock
2232

2333
### Git Branches
2434

25-
Please **always** base your pull request on the current GHC version branch
35+
If your patch consists of glue code and interface changes with GHC, please
36+
open a Pull Request targeting the `ghc-head` branch.
37+
38+
Otherwise, for improvements to the documentation generator,
39+
please base your pull request on the current GHC version branch
2640
(`ghc-9.0` for instance). The PR will be forward-ported to `ghc-head`
27-
so that GHC can use it.
41+
so that documentation built within GHC can benefit from it.
2842

2943
### Building the packages
3044

0 commit comments

Comments
 (0)