Skip to content

Commit 2941206

Browse files
committed
Update CONTRIBUTING.md
1 parent 7a64dc4 commit 2941206

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

docs/CONTRIBUTING.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,21 +20,24 @@ on a PR that may be rejected.
2020

2121
You can run tests normally with `go test`.
2222
You'll need the [Autobahn Test suite pip package](https://github.com/crossbario/autobahn-testsuite).
23+
In the future this dependency will be removed. See [#117](https://github.com/nhooyr/websocket/issues/117).
2324

2425
On submission please check if CI has passed and if not, please correct your code such that it does.
25-
If necessary, you may run CI locally with the `ci/run.sh` script.
26-
You'll only need [shellcheck](https://github.com/koalaman/shellcheck#installing).
26+
If necessary, you may run CI locally with the `ci/run.sh` script which will fmt, lint and test your code
27+
with coverage.
28+
You'll need [shellcheck](https://github.com/koalaman/shellcheck#installing), node and the
29+
Autobahn Test suite linked above.
2730

2831
For coverage details locally, please see `ci/out/coverage.html` after running `ci/run.sh` or `ci/test.sh`.
2932
For remote coverage, you can use either [codecov](https://codecov.io/gh/nhooyr/websocket) or download the
30-
`coverage.html` generated by the go tooling as an artifact on CI.
33+
`coverage.html` artifact on the test step in CI.
3134

32-
You can also run any of the steps individually. All of them are scripts in the `ci` directory.
35+
You can also run any of the CI steps individually. All of them are scripts in the `ci` directory.
3336

3437
See [../ci/lint.sh](../ci/lint.sh) and [../ci/test.sh](../ci/test.sh) for the
35-
installation of shellcheck and the Autobahn test suite on Debian or Ubuntu.
38+
installation of shellcheck, node and the Autobahn test suite on Debian or Ubuntu.
3639

3740
For Go, please refer to the [offical docs](https://golang.org/doc/install).
3841

3942
You can benchmark the library with `./ci/benchmark.sh`. You only need Go to run that script. Benchmark
40-
profiles generated by that script are also available for every CI job as artifacts.
43+
profiles generated by that script are also available as artifacts on the bench step.

0 commit comments

Comments
 (0)