Skip to content

Commit

Permalink
updated unit test instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
dr-joe-wirth committed Jul 30, 2024
1 parent c6c8e34 commit bc85cf3
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
1 change: 1 addition & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,6 @@ Thank you for showing interest in contributing to `primerForge`! Here are few gu
* Fix the issue on your new branch
* Make commits of logical and atomic units
* Add any new unit tests to help with longetivity. Unit tests have a file extension `_test.py`, rely on the `unittest` framework in Python3, and should be placed in the directory `bin/unit_tests`.
- unit tests can be run using the command `python3 -m unittest discover -s ./primerForge/bin/unit_tests/ -p "*_test.py"`
* If the unit test(s) show any errors on your local computer, then fix these errors.
* Make a pull request __with the `devel` branch__ when all unit tests show no errors.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,10 @@ git clone https://github.com/dr-joe-wirth/primerForge.git
Once installed and cloned, run the following commands to run the unit tests:

> [!NOTE]
> Running `results_test.py` may take up to three hours to complete
> Running `results_test.py` may take up to 30 minutes to complete
```bash
python3 -m unittest discover -s .primerForge/bin/unit_tests/ -p "*_test.py"
python3 -m unittest discover -s ./primerForge/bin/unit_tests/ -p "*_test.py"
```


Expand Down

0 comments on commit bc85cf3

Please sign in to comment.