Skip to content

Commit

Permalink
doc: add information on adding tests
Browse files Browse the repository at this point in the history
Signed-off-by: Ali Caglayan <[email protected]>
  • Loading branch information
Alizter committed Sep 3, 2023
1 parent 9826311 commit 0b3e8d8
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 0 deletions.
22 changes: 22 additions & 0 deletions test/README.md
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).

2 changes: 2 additions & 0 deletions test/dune
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,5 @@
(name HoTT.Tests)
(theories HoTT)
(flags -noinit -indices-matter -color on))

(include_subdirs qualified)

0 comments on commit 0b3e8d8

Please sign in to comment.