Repository navigation
docs: add CONTRIBUTING.md with dev setup and quality checks - #15
Conversation
IkarusAILabs
left a comment
There was a problem hiding this comment.
Thanks, this is a clear guide and it's accurate. I checked it against the code:
- the setup command and all four checks work;
AssessmentLimitationandClaimResult.UNKNOWNexist;- the scenario steps match the code layout.
It also merges cleanly onto the current main, where all 72 tests pass.
Two small additions before merge:
1. Adding a scenario should also update the baseline checklist. Under "Adding simulated scenarios", please add a step to score the new scenario in the desk-scoring table in docs/baseline-checklist.md. That table compares HaltAI with a manual runbook scenario by scenario, so a new scenario left out of it drops out of that comparison. Something like:
- Add a row for the scenario to the scoring table in
docs/baseline-checklist.md, rating both the checklist and HaltAI.
2. A licence line. Please add a short section stating that contributions are accepted under the project's licence, for example:
License
HaltAI is licensed under Apache-2.0. By contributing, you agree that your contributions are licensed under the same terms (see LICENSE).
That's all. Once these are in, I'm happy to approve.
|
Hi @IkarusAILabs, Both requested additions have been applied and upstream changes reconciled:
Local verification completed cleanly ( |
Resolves #4
Summary
Adds a standard
CONTRIBUTING.mdguide to onboard contributors cleanly, document local development setup, list mandatory CI verification checks, and state project contribution rules.Changes
CONTRIBUTING.mdcovering:pip install -e ".[dev]".ruff check .,mypy src,pytest,cd examples && haltai matrix).CONTRIBUTING.mdfrom the documentation table inREADME.md.Verification
CONTRIBUTING.mdlocally:ruff check .-> passedmypy src-> passedpytest-> 69 passedcd examples && haltai matrix-> 11 scenarios matched