docs: refresh README to reflect MEP v2 quality & safety features#13
Open
amar-python wants to merge 1 commit into
Open
docs: refresh README to reflect MEP v2 quality & safety features#13amar-python wants to merge 1 commit into
amar-python wants to merge 1 commit into
Conversation
- New 'MEP Backend — Reliability & Safety Features' section documenting: migration run lifecycle state machine (UPLOADING/VALIDATING/READY/ERROR), CsvParser service, production safety gate (ALLOW_SCHEMA_AUTO_CREATE), typed Pydantic response models, shell script hardening, CI workflow path verification (tools/verify_workflow_paths.py), and the security suppression policy (docs/security/Rationale.md) - Repository layout updated (tools/, backend/tests/, docs/security|ci, PR template) - 'Running the MEP backend tests' instructions; note suite growth 38 → 100+ - Fixed all stale legacy engine paths: build/, tests/, evals/ commands now use backend/migration/... (loader, utilise, deploy, test runners, evals) - Engine repository-structure tree re-rooted at backend/migration/ - Contributing section rewritten around the new PR template with 'Tests Added' and 'Verified Workflow Paths' checklists - Removed stale 'Acknowledgements' section (leftover session prompts for an unrelated repository)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Comprehensive README refresh documenting the current project state, including the code-quality work delivered in #10, #11, and #12.
What changed
New: "MEP Backend — Reliability & Safety Features" section
CREATED → UPLOADING → VALIDATING → READY → MIGRATING → COMPLETED, withERROR/FAILEDpaths), verified againstALLOWED_TRANSITIONSinbackend/database/models.pyon the fix(data): robust CSV parser, migration run state machine, shell script hardening #11 branchALLOW_SCHEMA_AUTO_CREATE+ fail-fast validation whenAPP_ENV=productionresponse_modelon every endpoint; internal paths never leaked--envvalidation,evalremovaltools/verify_workflow_paths.pyusagedocs/security/Rationale.mdAccuracy fixes to existing content
backend/migration/...(setup/deploy/test runners,csv_loader.sh,csv_utilise.sh,evals/runner.py, PowerShell runners, psql invocation) — matches the actual tree and the CI workflow's own pathbackend/migration/with an explanatory note; evals badge link fixedtools/,backend/tests/,docs/security|ci, PR template)Contributing
response_modelrequirement,RunStatuslifecycle rule, suppression-documentation rule, correct test pathsRemoved
amar-python/TestUploadtoGIT)Verification
backend/migration/...path referenced in the README was existence-checked against the working tree (all present)ALLOWED_TRANSITIONSonfix/data-integrity-safetyMakefilecsv-demo/csv-loadtargets confirmed to existChecklist