diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 4019cc1..f217f7e 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -31,12 +31,14 @@ git checkout -b dev/ # always create a new branch Branch naming: `dev/` (e.g., `dev/recoil-correction`) + ### Merging Rules - All work happens on `dev/*` branches — never commit directly to `main` - Tests MUST pass before any merge attempt - Merging to `main` requires a pull request with passing CI checks - If tests fail, fix them on the dev branch — do NOT merge broken code +- Before merging always update TODO.md and README.md ## 3. Test-Driven Development @@ -46,6 +48,8 @@ Branch naming: `dev/` (e.g., `dev/recoil-correction`) 2. **Green** — implement minimal code to make the test pass 3. **Refactor** — clean up code while keeping all tests green +Commit work-in-progress changes to development branch. + ### Test Conventions - Tests live in `tests/` with the same structure as `beta_spectrum/` @@ -128,6 +132,7 @@ When working on this project, agents must: - [ ] Type checks pass (`mypy`) - [ ] Update version in `pyproject.toml` - [ ] Update `Development Status` section in `README.md` +- [ ] Update `TODO.md` marking corresponding items as complete. - [ ] Commit changes - [ ] Create git tag: `git tag v` - [ ] Push to remote