Skip to content

Commit ad19917

Browse files
Update README with testing documentation and test badge
Co-authored-by: willtheorangeguy <[email protected]>
1 parent 3c2c26f commit ad19917

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515
<img alt="PyPI Build State" src="https://github.com/Dog-Face-Development/ProgramVer/actions/workflows/push-to-pypi.yml/badge.svg">
1616
<!-- Stability -->
1717
<img alt="Pylint State" src="https://github.com/Dog-Face-Development/ProgramVer/actions/workflows/pylint.yml/badge.svg">
18+
<!-- Tests -->
19+
<img alt="Tests State" src="https://github.com/Dog-Face-Development/ProgramVer/actions/workflows/tests.yml/badge.svg">
1820
<!-- CodeQL -->
1921
<img alt="CodeQL State" src="https://github.com/Dog-Face-Development/ProgramVer/actions/workflows/codeql-analysis.yml/badge.svg">
2022
<!-- Version -->
@@ -106,6 +108,36 @@ However, you may want to add the version window to your program. To do so, follo
106108

107109
Customization for ProgramVer can be found in the [`CUSTOMIZATION`](https://github.com/Dog-Face-Development/ProgramVer/blob/master/docs/CUSTOMIZATION.md) doc. More documentation is available in the **[Documentation](https://github.com/Dog-Face-Development/ProgramVer/tree/master/docs)** and on the **[Wiki](https://github.com/Dog-Face-Development/ProgramVer/wiki)**. If more support is required, please open a **[GitHub Discussion](https://github.com/Dog-Face-Development/ProgramVer/discussions)** or join our **[Discord](https://discord.gg/x3G8adwVUe)**.
108110

111+
## Testing
112+
113+
ProgramVer includes a comprehensive test suite to ensure code quality and reliability. The test suite achieves 100% code coverage for the main module.
114+
115+
### Running Tests
116+
117+
To run the test suite locally:
118+
119+
```bash
120+
# Install test dependencies
121+
pip install -r requirements.txt
122+
123+
# Run tests (Linux)
124+
xvfb-run -a python -m pytest tests/ -v
125+
126+
# Run tests (Windows/macOS)
127+
python -m pytest tests/ -v
128+
129+
# Run tests with coverage
130+
python -m pytest tests/ --cov=main --cov-report=term-missing
131+
```
132+
133+
For more information about testing, see the [tests README](tests/README.md).
134+
135+
### Continuous Integration
136+
137+
Tests are automatically run on GitHub Actions for every push and pull request across:
138+
- Operating Systems: Ubuntu, Windows, and macOS
139+
- Python Versions: 3.9, 3.10, 3.11, and 3.12
140+
109141
## Contributing
110142

111143
Please contribute using [GitHub Flow](https://guides.github.com/introduction/flow). Create a branch, add commits, and [open a pull request](https://github.com/Dog-Face-Development/ProgramVer/compare).

0 commit comments

Comments
 (0)