Final documentation and submission cleanup #12

Activity

1. FriggemannMichael

   added this to the Week 4 - Testing, Hardening, and Submission milestone on Jun 30, 2026
2. FriggemannMichael

   added

   documentationImprovements or additions to documentationImprovements or additions to documentation

   planned-taskPlanned project implementation taskPlanned project implementation task

   area:setupProject setup, structure, and configurationProject setup, structure, and configuration

   tddTest-driven development: write or define tests before implementationTest-driven development: write or define tests before implementation

   on Jun 30, 2026
3. FriggemannMichael commented on Jun 30, 2026

   

   FriggemannMichael

   on Jun 30, 2026

   Last edited by FriggemannMichael

   OwnerAuthor

   More actions

   TDD workflow for this project:

   • Define the expected behavior before implementing the endpoint or model behavior.
   • Write or outline the failing test first.
   • Implement only enough code to make that test pass.
   • Refactor after the test passes.
   • Keep Django check, Ruff, and the relevant tests green from the local virtual environment.
4. FriggemannMichael commented on Jul 6, 2026

   

   FriggemannMichael

   on Jul 6, 2026

   OwnerAuthor

   More actions

   Follow-up bugs found during the docs-vs-implementation review (see acceptance criterion "docs/checkliste.md and docs/endpoints.md are reviewed against the implementation"). Tracked separately so this issue stays a clean submission checklist:

   • PATCH /api/orders/{id}/ returns 404 instead of 403 for a non-owner business user #29 — PATCH /api/orders/{id}/ returns 404 instead of the documented 403 for a non-owner business user
   • Orders permissions/get_queryset raise 500 for users without a UserProfile #30 — Orders permissions/get_queryset raise 500 for users without a UserProfile
5. FriggemannMichael

   closed this as completedin #35on Jul 7, 2026
6. FriggemannMichael commented on Jul 7, 2026

   

   FriggemannMichael

   on Jul 7, 2026

   OwnerAuthor

   More actions

   Submission cleanup complete — closing summary. All acceptance criteria met:

   • README rewritten with a project overview, feature list, user-type/auth notes, and accurate project structure (Rewrite README with project overview and features #35).
   • requirements.txt pinned and reproducible — pip freeze matches the file (Pin missing type-stub dependencies in requirements.txt #36).
   • Database and local files are not tracked; .gitignore covers db.sqlite3, .venv/, media/, staticfiles/, IDE and env files (verified clean).
   • No print() debugging, commented-out code, or unrelated files remain (verified clean).
   • Ruff (incl. D101), Django checks, and pytest all pass locally; coverage ~99%.
   • docs/endpoints.md is cross-checked against the implementation by the contract test (no remaining xfail markers).