diff --git a/readme.md b/readme.md index d16acd9..208f575 100644 --- a/readme.md +++ b/readme.md @@ -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