Add RC-006 (source code against QC-PY-001) and RC-007 (MIL-004), and update the traceability matrix. Set lower bounds for the dev dependencies, the one optional Fail in RC-006. Add a Gitea Actions workflow running pytest, ruff and mypy, and describe it in the README. Accept MIL-004 and link its Milestone in the Project Plan. Closes #24 Closes #25 Closes #26 Closes #27 Closes #28 Task: MIL-004#1 Task: MIL-004#2 Task: MIL-004#3 Task: MIL-004#4 Task: MIL-004#5
This commit is contained in:
@@ -79,6 +79,16 @@ python -m ruff format --check src tests
|
||||
python -m mypy src tests
|
||||
```
|
||||
|
||||
## Continuous integration
|
||||
|
||||
On every push and pull request, `.gitea/workflows/ci.yml` installs the project on
|
||||
Python 3.13 and runs the same checks as above: `pytest`, `ruff check`,
|
||||
`ruff format --check` and `mypy`. To run all of them locally:
|
||||
|
||||
```bash
|
||||
python -m pytest && python -m ruff check src tests && python -m ruff format --check src tests && python -m mypy src tests
|
||||
```
|
||||
|
||||
## Build the source documentation
|
||||
|
||||
The source uses Doxygen comments. The HTML output goes to `docs/doxygen/html`.
|
||||
@@ -96,6 +106,7 @@ doxygen Doxyfile
|
||||
| `docs/` | Planning and review documents (business case, plan, milestones) |
|
||||
| `pyproject.toml` | Project configuration |
|
||||
| `Doxyfile` | Doxygen configuration |
|
||||
| `.gitea/workflows/` | CI workflow |
|
||||
|
||||
## License
|
||||
|
||||
|
||||
Reference in New Issue
Block a user