Skip to content

Commit

Permalink
doc: add more information in doc
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 e80f38a commit 694b8d7
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 4 deletions.
16 changes: 12 additions & 4 deletions test/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,25 @@
# Tests

Here we collect tests from various issues and PRs.
Sometimes there are some properties about the library that we would like to test
without polluting it with examples and noisy output. Such tests are collected
here.

Here we also collect regression tests from various issues and PRs in a
subdirectory called `bugs/`.

## 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`.
To add a test, create a new .v file in this directory.

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`.


For regression tests, 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` and they should be placed in `bugs/`.

## Running tests

To run the tests, simply run
Expand Down
5 changes: 5 additions & 0 deletions test/dune
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,8 @@
(flags -noinit -indices-matter -color on))

(include_subdirs qualified)

(alias
(name runtest)
(deps
(glob_files_rec ./*.vo)))

0 comments on commit 694b8d7

Please sign in to comment.