-
Notifications
You must be signed in to change notification settings - Fork 193
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: add information on adding tests
Signed-off-by: Ali Caglayan <[email protected]>
- Loading branch information
Showing
2 changed files
with
24 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# Tests | ||
|
||
Here we collect tests from various issues and PRs. | ||
|
||
## Adding a test | ||
|
||
To add a test, create a new .v file in this directory. The file name should be | ||
`github<issue number>.v` or `github<PR number>.v`. For example, if you are | ||
adding a test for issue #123, the file name should be `github123.v`. | ||
|
||
When testing properties of the library, try to keep the same directory | ||
structure. For instance, tests about suspensions should be in | ||
`Test/Homotopy/Suspension.v`. | ||
|
||
## Running tests | ||
|
||
To run the tests, simply run | ||
``` | ||
dune test | ||
``` | ||
from the root of the repository (or here). | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,3 +2,5 @@ | |
(name HoTT.Tests) | ||
(theories HoTT) | ||
(flags -noinit -indices-matter -color on)) | ||
|
||
(include_subdirs qualified) |