Skip to content

Commit 727dd54

Browse files
committed
Cleanup CONTRIBUTING.md
1 parent a134edc commit 727dd54

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

docs/CONTRIBUTING.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Be sure to [correctly link](https://help.github.com/en/articles/closing-issues-u
2323
to an existing issue if one exists. In general, create an issue before a PR to get some
2424
discussion going and to make sure you do not spend time on a PR that may be rejected.
2525

26-
The Go module where development occurs is in the [./mod](./mod) subpath so that the README.md
26+
The Go module where development occurs is in the [mod](../mod) subpath so that the README.md
2727
is immediately visible on the main page.
2828

2929
CI must pass on your changes for them to be merged.
@@ -35,21 +35,21 @@ It will collect coverage and report it to [codecov](https://codecov.io/gh/nhooyr
3535
and also upload a `out/coverage.html` artifact that you can click on to interactively
3636
browse coverage.
3737

38-
You can run CI locally. The various steps are located in `mod/ci/*.sh`.
38+
You can run CI locally. The various steps are located in [mod/ci/\*.sh](../mod/ci).
3939

40-
1. `mod/ci/fmt.sh` which requires node (specifically prettier).
41-
1. `mod/ci/lint.sh` which requires [shellcheck](https://github.com/koalaman/shellcheck#installing).
42-
1. `mod/ci/test.sh`
43-
1. `mod/ci/run.sh` which runs the above scripts in order.
40+
1. [fmt.sh](../mod/ci/fmt.sh) which requires node (specifically prettier).
41+
1. [lint.sh](../mod/ci/lint.sh) which requires [shellcheck](https://github.com/koalaman/shellcheck#installing).
42+
1. [test.sh](../mod/ci/test.sh)
43+
1. [run.sh](../mod/ci/run.sh) which runs the above scripts in order.
4444

45-
For coverage details locally, please see `mod/ci/out/coverage.html` after running `mod/ci/test.sh`.
45+
For coverage details locally, please see `mod/ci/out/coverage.html` after running [test.sh](../mod/ci/test.sh).
4646

47-
See [mod/ci/image/Dockerfile](mod/ci/image/Dockerfile) for the installation of the CI dependencies on Ubuntu.
47+
See [mod/ci/image/Dockerfile](../mod/ci/image/Dockerfile) for the installation of the CI dependencies on Ubuntu.
4848

49-
You can also run tests normally with `go test`. `mod/ci/test.sh` just passes a default set of flags to
50-
`go test` to collect coverage, enable the race detector and also prettifies the output.
49+
You can also run tests normally with `go test`. [test.sh](../mod/ci/test.sh) just passes a default set of flags to
50+
`go test` to collect coverage and also prettify the output.
5151

52-
You can pass flags to `mod/ci/test.sh` if you want to run a specific test or otherwise
53-
control the behaviour of `go test`.
52+
You can pass flags to [test.sh](mod/ci/test.sh) if you want to run a specific test or otherwise
53+
control the behaviour of `go test` but also get coverage.
5454

5555
Coverage percentage from codecov and the CI scripts will be different because they are calculated differently.

0 commit comments

Comments
 (0)