Skip to content

Commit 5f444b1

Browse files
committed
docs: mention testing script in developer docs
1 parent 8486111 commit 5f444b1

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

docs/src/91-developer.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,24 @@ pkg> activate .
6868
pkg> test
6969
```
7070

71+
Alternatively, if you have
72+
[`ReTestItems.jl`](https://github.com/JuliaTesting/ReTestItems.jl),
73+
[`TestEnv.jl`](https://github.com/JuliaTesting/TestEnv.jl), and
74+
[`Revise.jl`](https://timholy.github.io/Revise.jl/stable) installed, you can use the script
75+
at `test/quick.jl` for rapid testing. This allows you to make changes and immediately run the entire test
76+
suite with those changes. The upside to this setup is that the tests will fail fast, and if
77+
you re-run, the tests that failed on the most recent run will run first. This is great if
78+
you're just iterating on one part of the package and trying to get a handful of tests to
79+
pass. You won't waste time on waiting for other tests to pass and you don't have to manually
80+
select which tests you're actively working on.
81+
82+
```julia-repl
83+
julia> include("test/quick.jl")
84+
```
85+
86+
is all you need to get up and running. Rerunning `include` will rerun the tests as described
87+
above.
88+
7189
## Working on a new issue
7290

7391
We try to keep a linear history in this repo, so it is important to keep your branches up-to-date.

0 commit comments

Comments
 (0)