Skip to content

Commit 3907f3c

Browse files
committed
Updated README to have status about the CI tests and coverage
1 parent 1cac330 commit 3907f3c

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[![PyPI version](https://img.shields.io/pypi/v/rexplain.svg)](https://pypi.org/project/rexplain/)
44
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/rexplain)
55
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
6+
[![Tests](https://github.com/devbm7/rexplain/workflows/Test/badge.svg)](https://github.com/devbm7/rexplain/actions/workflows/test.yml)
7+
[![Coverage](https://img.shields.io/badge/coverage-70%25+-brightgreen)](https://github.com/devbm7/rexplain/actions/workflows/test.yml)
68

79
Explain, test, and generate examples for regular expressions.
810

@@ -108,14 +110,20 @@ Contributions are welcome! To contribute:
108110

109111
## Running Tests & Coverage
110112

111-
To run all tests with coverage (threshold: 90%):
113+
To run all tests with coverage (threshold: 70%):
112114

113115
```bash
114116
pip install .[test]
115117
pytest
116118
```
117119

118-
If coverage is below 90%, pytest will fail. Coverage details will be shown in the terminal.
120+
If coverage is below 70%, pytest will fail. Coverage details will be shown in the terminal.
121+
122+
### Test Coverage Details
123+
- **Required Threshold**: 70%
124+
- **Covered Modules**: All core functionality with comprehensive test coverage
125+
- **Missing Coverage**: Mainly CLI interface and some edge cases in diagram generation
126+
- **Live Status**: Check the [GitHub Actions](https://github.com/devbm7/rexplain/actions/workflows/test.yml) for current coverage reports
119127

120128
## License
121129

0 commit comments

Comments
 (0)