Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 14 additions & 26 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,16 +148,27 @@ from a binary, and then build the haddocks for the project.

Often times, it is useful to have a
[`hoogle`](https://github.com/ndmitchell/hoogle) server at hand, with the
packages and its dependencies. Our suggestion is to install
[`cabal-hoogle`](https://github.com/kokobd/cabal-hoogle) from github:
packages and its dependencies.

Our suggestion is to use
[`cabal-hoogle`](https://github.com/kokobd/cabal-hoogle), which is included in
the `nix` shell:

```bash
nix develop
$ cabal-hoogle generate
$ cabal-hoogle run -- server --local
```

If you're not using `nix`, you may install `cabal-hoogle` from github:

```bash
git clone [email protected]:kokobd/cabal-hoogle
cd cabal-hoogle
cabal install exe:cabal-hoogle
```

and then run `cabal-hoogle`:
Regardless, once it's available in your environment, run `cabal-hoogle`:

```bash
cabal-hoogle generate
Expand Down Expand Up @@ -217,29 +228,6 @@ the right version of `fourmolu`.
nix develop -c ./scripts/ci/run-fourmolu.sh
```

# Generating documentation and setting up hoogle

To generate the documentation, use the documentation script:

```bash
./scripts/docs/haddocks.sh
```

Often times, it is useful to have a
[`hoogle`](https://github.com/ndmitchell/hoogle) server at hand, with the
packages and its dependencies. Our suggestion is to use
[`cabal-hoogle`](https://github.com/kokobd/cabal-hoogle) which is included in
the `nix` shell:

```bash
nix develop
$ cabal-hoogle generate
$ cabal-hoogle run -- server --local
```

This will fire a `hoogle` server at https://localhost:8080/ with the local
packages and their dependencies.

## Making and reviewing changes

If you are working on changing a **substantial** part of Consensus, it is
Expand Down