Skip to content

Commit b4336c1

Browse files
committed
Improve coverage instructions
1 parent c3de51f commit b4336c1

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

.github/copilot-instructions.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,21 @@ issue number is being addressed.
4141

4242
When writing tests, you can use the [`raco cover`][9] command to check the
4343
code coverage of your test cases. The command `raco cover path/to/file.rkt`
44-
will generate an HTML report showing what code is covered by the indicated test.
45-
To check for all tests in the repository, you can run `raco cover --package resyntax`.
44+
will generate an HTML report showing what code is covered by running the
45+
indicated files. To check coverage for the whole repository, you can run
46+
this command:
47+
48+
```bash
49+
raco cover --suppress-log-execution --package resyntax
50+
```
51+
52+
The `--suppress-log-execution` flag is necessary to avoid a bug in `raco cover`
53+
related to Racket's logging system. The `raco cover` tool has a few other sharp
54+
edges like this; see its documentation for more details.
55+
4656
Pull requests should aim for high code coverage, and an integration with Coveralls
47-
is set up to help track coverage over time. Beware that `raco cover` has some
48-
sharp edges and inconsistencies compared to `raco test`; see its documentation for
49-
more details.
57+
is set up to help track coverage over time. You can view the Coveralls report for
58+
the entire repository at [this link][10].
5059

5160
[1]: https://docs.racket-lang.org/resyntax/
5261
[2]: https://racket-lang.org/
@@ -57,3 +66,4 @@ more details.
5766
[7]: https://github.com/herbie-fp/herbie
5867
[8]: https://github.com/racket/typed-racket
5968
[9]: https://docs.racket-lang.org/cover/
69+
[10]: https://coveralls.io/github/jackfirth/resyntax

0 commit comments

Comments
 (0)