Skip to content

Commit

Permalink
docs: updating contributing information on pytest marks
Browse files Browse the repository at this point in the history
Signed-off-by: Kin Long Kelvin Lee <[email protected]>
  • Loading branch information
laserkelvin committed Mar 12, 2024
1 parent 881edc9 commit 1b9b882
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,14 @@ Tests for each new model and datasets should be added to their respective tests

Model tests may be added [here](https://github.com/IntelLabs/matsciml/tree/main/matsciml/models/dgl/tests), and dataset tests may be added to their respective dataset folders when created.

We have also defined a set of `pytest.mark`s for categorizing tests, which include:

- `pytest.mark.slow` - for compute heavy tests, which we want to avoid for CI
- `pytest.mark.remote_request` - for remote API requests, which we want to avoid for CI
- `pytest.mark.lmdb` - for LMDB/IO based actions, which can be slow with CI

Please decorate tests accordingly. If a particular case isn't captured, feel free to add new marks and append to this list.

## General Guidelines

- Make your code readable and maintainable. Use meaningful variable and function names.
Expand Down

0 comments on commit 1b9b882

Please sign in to comment.