Skip to content

Commit 571ab8f

Browse files
committed
docs: add test and quality commands to README
1 parent 18792f1 commit 571ab8f

File tree

1 file changed

+32
-1
lines changed

1 file changed

+32
-1
lines changed

README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,12 +116,43 @@ vidinsight/
116116
}
117117
```
118118

119-
## Running Tests
119+
## Development
120+
121+
### Running Tests
120122

121123
```bash
124+
# Run all tests
122125
uv run pytest tests/ -v
126+
127+
# Run with coverage report
128+
uv run pytest tests/ -v --cov=api --cov-report=term-missing
129+
130+
# Run specific test file
131+
uv run pytest tests/test_youtube.py -v
132+
```
133+
134+
### Code Quality
135+
136+
```bash
137+
# Lint check
138+
uv run ruff check api/ tests/
139+
140+
# Auto-fix lint issues
141+
uv run ruff check api/ tests/ --fix
142+
143+
# Format code
144+
uv run ruff format api/ tests/
145+
146+
# Check formatting (CI mode)
147+
uv run ruff format --check api/ tests/
123148
```
124149

150+
### CI Pipeline
151+
152+
GitHub Actions runs on every push/PR:
153+
- **Lint**: Ruff check + format verification
154+
- **Test**: pytest with 75% coverage threshold
155+
125156
## License
126157

127158
MIT

0 commit comments

Comments
 (0)