Skip to content

Commit b046849

Browse files
committed
docs(docs/*.md): verified all documented commands working
uniformly using pytest --cov for coverage because project is an app and not a python package. removed redundant docker-design sections because already implemented in cicd automation
1 parent e71d711 commit b046849

File tree

3 files changed

+2
-20
lines changed

3 files changed

+2
-20
lines changed

docs/developer-guide.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ When adding new features or customizations, make sure to:
203203
pytest
204204

205205
# Run with coverage
206-
pytest --cov=strain_seer
206+
pytest --cov
207207
```
208208

209209
## 📦 Dependencies

docs/docker-design.md

-18
Original file line numberDiff line numberDiff line change
@@ -164,21 +164,3 @@ HEALTHCHECK --interval=30s --timeout=30s --start-period=5s --retries=3 \
164164
- Clear stage separation
165165
- Well-documented environment variables
166166
- Consistent naming conventions
167-
168-
## 🔄 Future Considerations
169-
170-
1. **Versioning**:
171-
- Consider using specific version tags
172-
- Implement automated version bumping
173-
174-
2. **CI/CD Integration**:
175-
- Add automated testing in container
176-
- Implement automated builds and pushes
177-
178-
3. **Monitoring**:
179-
- Add logging configuration
180-
- Consider metrics collection
181-
182-
4. **Security**:
183-
- Regular dependency updates
184-
- Security scanning integration

tests/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Tests data processing and visualization in `strain_analysis_data.py`:
4242
```shell
4343
pytest # Run all tests
4444

45-
pytest --cov tests/ # Run with coverage
45+
pytest --cov # Run with coverage
4646
```
4747

4848
## 📝 Best Practices

0 commit comments

Comments
 (0)