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

Commit 7d46188

Browse files
committed
Redirect contributors to the Haskell Gitlab
1 parent d073163 commit 7d46188

File tree

1 file changed

+1
-76
lines changed

1 file changed

+1
-76
lines changed

CONTRIBUTING.md

+1-76
Original file line numberDiff line numberDiff line change
@@ -1,78 +1,3 @@
11
# Contributing to Haddock
22

3-
Thank you for contributing to Haddock! Here is the information you will need in
4-
order to make your contribution
5-
6-
## Code of Conduct
7-
8-
We need you to read, acknowledge, and abide by our [Code of Conduct][CoC].
9-
10-
## Reporting issues
11-
12-
Please open a ticket if you get an unexpected behaviour from Haddock!
13-
You should ideally include a [Short, Self Contained, Correct (Compilable), Example][SSCCE]
14-
in your ticket, so that the maintainers may easily reproduce your issue.
15-
16-
Here is a list of things you should include in your ticket
17-
18-
* Your GHC version.
19-
20-
* Your platform, OS and distribution if applicable.
21-
22-
* Your cabal version if applicable.
23-
24-
* Include any other info you think might be relevant (sandbox? unusual setup?).
25-
26-
## Hacking
27-
28-
To get started you'll need the latest GHC release installed.
29-
30-
Clone the repository:
31-
32-
```bash
33-
git clone https://github.com/haskell/haddock.git
34-
cd haddock
35-
```
36-
37-
### Git Branches
38-
39-
If your patch consists of glue code and interface changes with GHC, please
40-
open a Pull Request targeting the `ghc-head` branch.
41-
42-
Otherwise, for improvements to the documentation generator,
43-
please base your pull request on the current GHC version branch
44-
(`ghc-9.0` for instance). The PR will be forward-ported to `ghc-head`
45-
so that documentation built within GHC can benefit from it.
46-
47-
### Building the packages
48-
49-
#### Using `cabal`
50-
51-
Requires cabal `>= 3.4` and GHC `== 9.4`:
52-
53-
You can install the latest build of GHC via ghcup using this command:
54-
55-
```bash
56-
ghcup install ghc -u "https://gitlab.haskell.org/ghc/ghc/-/jobs/artifacts/master/raw/ghc-x86_64-deb9-linux-integer-simple.tar.xz?job=validate-x86_64-linux-deb9-integer-simple" head
57-
```
58-
59-
```bash
60-
cabal v2-build all --enable-tests
61-
cabal v2-test all
62-
```
63-
64-
### Updating golden testsuite outputs
65-
66-
If you've changed Haddock's output, you will probably need to accept the new
67-
output of Haddock's golden test suites (`html-test`, `latex-test`,
68-
`hoogle-test`, and `hypsrc-test`). This can be done by passing the `--accept`
69-
argument to these test suites. With a new enough version of `cabal-install`:
70-
71-
```
72-
cabal v2-test html-test latex-test hoogle-test hypsrc-test \
73-
--test-option='--accept'
74-
```
75-
76-
77-
[SSCCE]: http://sscce.org/
78-
[CoC]: ./CODE_OF_CONDUCT.md
3+
Please open tickets and contributions at https://gitlab.haskell.org/ghc/ghc.

0 commit comments

Comments
 (0)