From 29412064484c0d331096628fc00f9441b3e147eb Mon Sep 17 00:00:00 2001 From: Anmol Sethi <hi@nhooyr.io> Date: Tue, 20 Aug 2019 19:37:35 -0400 Subject: [PATCH] Update CONTRIBUTING.md --- docs/CONTRIBUTING.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 951a326..adc1bd0 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -20,21 +20,24 @@ on a PR that may be rejected. You can run tests normally with `go test`. You'll need the [Autobahn Test suite pip package](https://github.com/crossbario/autobahn-testsuite). +In the future this dependency will be removed. See [#117](https://github.com/nhooyr/websocket/issues/117). On submission please check if CI has passed and if not, please correct your code such that it does. -If necessary, you may run CI locally with the `ci/run.sh` script. -You'll only need [shellcheck](https://github.com/koalaman/shellcheck#installing). +If necessary, you may run CI locally with the `ci/run.sh` script which will fmt, lint and test your code +with coverage. +You'll need [shellcheck](https://github.com/koalaman/shellcheck#installing), node and the +Autobahn Test suite linked above. For coverage details locally, please see `ci/out/coverage.html` after running `ci/run.sh` or `ci/test.sh`. For remote coverage, you can use either [codecov](https://codecov.io/gh/nhooyr/websocket) or download the -`coverage.html` generated by the go tooling as an artifact on CI. +`coverage.html` artifact on the test step in CI. -You can also run any of the steps individually. All of them are scripts in the `ci` directory. +You can also run any of the CI steps individually. All of them are scripts in the `ci` directory. See [../ci/lint.sh](../ci/lint.sh) and [../ci/test.sh](../ci/test.sh) for the -installation of shellcheck and the Autobahn test suite on Debian or Ubuntu. +installation of shellcheck, node and the Autobahn test suite on Debian or Ubuntu. For Go, please refer to the [offical docs](https://golang.org/doc/install). You can benchmark the library with `./ci/benchmark.sh`. You only need Go to run that script. Benchmark -profiles generated by that script are also available for every CI job as artifacts. +profiles generated by that script are also available as artifacts on the bench step. \ No newline at end of file -- GitLab