readme: state current status and unblock agent workflow

Roadmap now reflects reality: config done, db tests red awaiting
implementation (with the 'do not alter test intent' guard), and the
epsilon-parser branch open-but-empty pending the step-2 spec.

Guidelines adjusted so an agent can work a feature branch
unattended: fixtures are the explicit exception to the data/ commit
ban, and per-passing-test commits need no feedback on a branch —
main still does.
This commit is contained in:
hermes
2026-10-08 11:31:20 +02:00
parent 5f8fa17865
commit af2826499c
+17 -4
View File
@@ -280,22 +280,35 @@ Use a test-driven-development inspired approach, specifically the following work
- Do not
- commit secrets or private data
- commit config files (except for template)
- commit anything under data/
- commit anything under data/ **except** `data/fixtures/`, which holds
sanitized sample data that is committed deliberately
(see §Data formats); run `scripts/check_fixture_leaks.py` (exit 0)
before ever touching fixtures
- add dependencies without asking
- refactor existing code as part of an unrelated task
- put secrets or real customer data in tests
- Git commit messages
- Follow best practices regarding format and context, but also keep in mind the commit messages are the main code documentation
- Always ask for feedback before actually committing
- Follow best practices regarding format and context, but also keep in mind
the commit messages are the main code documentation
- Always ask for feedback before actually committing to `main`; on a
feature branch, commit per passing test as part of the workflow without
waiting for feedback
- Be concise
## Roadmap and status of functionality
### Active
nothing yet…
* core/config — done (loading, resolution, defaults, masking, validation;
tests green, commit 9452962)
### In development
* core/db — tests committed and RED (connection URL, migration splitting,
embedded schema v1, backup/restore; commit 676e55e). Next step: minimal
implementation until green; do not alter the tests' intent.
* cli
* command structure specified in Documentation/cli.md
* ingest tab-separated .txt files containing transactions from automated gas station into a MariaDB
* feature branch feature/epsilon-parser is open but empty: no
spec/checklist yet (workflow step 2 pending); sanitized
fixtures are ready (data/fixtures/epsilon)
* create invoices from data in database
### Future / planned
* cli