Skip to content

Commit 0ff1046

Browse files
committed
ReadMe: update Contributing
1 parent f74c7f8 commit 0ff1046

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

ReadMe.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -310,9 +310,9 @@ hnix \
310310

311311
## Contributing
312312

313-
There is a Wiki article: [Design of the HNix code base](https://github.com/haskell-nix/hnix/wiki/Design-of-the-HNix-code-base).
313+
* The Haskell Language Server (HLS) works great with our project.
314314

315-
Haskell Language Server & Cabal development. Or development in the Nix shell environment.
315+
* [Design of the HNix code base Wiki article](https://github.com/haskell-nix/hnix/wiki/Design-of-the-HNix-code-base).
316316

317317
1. If something in the [quests](https://github.com/haskell-nix/hnix/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+no%3Aassignee) looks interesting, look through the thread and leave a comment taking it, to let others know you're working on it.
318318

@@ -321,15 +321,19 @@ Haskell Language Server & Cabal development. Or development in the Nix shell env
321321
3. When the pull request is ready to be submitted, to save time - please, test it with:
322322

323323
```shell
324-
git submodule update --init --recursive
325324
cabal v2-test
325+
326+
# If forgot to clone recursively, run:
327+
# git submodule update --init --recursive
326328
```
327329

328-
Please, check that all default tests that were passing prior are still passing for the PR, it is faster to check that locally than through CI. It's OK if no new tests are passing.
330+
Please, check that all default tests that were passing prior are still passing. It's OK if no new tests are passing.
329331
330332
331333
### (optional) Minimalistic development status loop with amazing [`ghcid`](https://github.com/ndmitchell/ghcid)
332334
335+
If HLS is not your cup of yea:
336+
333337
```shell
334338
ghcid --command="cabal v2-repl --repl-options=-fno-code --repl-options=-fno-break-on-exception --repl-options=-fno-break-on-error --repl-options=-v1 --repl-options=-ferror-spans --repl-options=-j"
335339
```

0 commit comments

Comments
 (0)