@@ -23,7 +23,7 @@ Be sure to [correctly link](https://help.github.com/en/articles/closing-issues-u
23
23
to an existing issue if one exists. In general, create an issue before a PR to get some
24
24
discussion going and to make sure you do not spend time on a PR that may be rejected.
25
25
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
27
27
is immediately visible on the main page.
28
28
29
29
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
35
35
and also upload a ` out/coverage.html ` artifact that you can click on to interactively
36
36
browse coverage.
37
37
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 ) .
39
39
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.
44
44
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) .
46
46
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.
48
48
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.
51
51
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 .
54
54
55
55
Coverage percentage from codecov and the CI scripts will be different because they are calculated differently.
0 commit comments