STATOTEST/contract-microservice
7
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

Prepare the codebase for handover: docs, lint and contributor guide #3

Merged
macoun merged 4 commits from docs/handover-readiness into main 2026-10-16 07:14:36 +00:00
Conversation 0 Commits 4 Files changed 37 +2237 -461
macoun commented 2026-10-16 07:06:24 +00:00
Owner
Copy link

Makes the repo easy to pick up for the next developer. No behaviour changes.

What changes

  • Docs match the code: README and every file in .context/ were checked
    against the code and updated (five roles, free configuration parameters
    instead of IO slots, no actor rules or flow versioning, exception mapping,
    rate limits, rich text with embedded files, branch/PR/CI workflow).
    codebase-map.md is rebuilt from the real layout, architecture.md is a real
    overview, operations.md gains the backup/restore and dead-letter procedures.
    Superseded ADRs get a one-line pointer; their bodies stay as history.
  • CONTRIBUTING.md: working rules, the path from branch to production, and
    short recipes for adding an endpoint, a column or table, a flow change, a
    notification, a frontend page and an npm package. Linked from the README.
  • ESLint for the frontend (TypeScript + React hooks rules, zero warnings
    allowed) with fixes for what it found: no setState inside effects, no ref
    written during render, complete effect dependencies. The contract list no
    longer lets a slow response for old filters overwrite newer results.
  • CI: a new frontend job runs npm ci, lint and build in node:24-alpine on
    every PR; the image build waits for it.
  • Stale leftovers removed: comments about the CTO role and IO slots, the
    unused SeededRoleIds class, "Cto" naming in demo data and tests.

Testing

  • 237 backend tests pass, lint clean, frontend build OK.
  • The new frontend CI job runs for the first time on this PR.

Deployment

No migrations, no runtime changes beyond the contract list fix. Update the
stack as usual (optional).

Makes the repo easy to pick up for the next developer. No behaviour changes. ## What changes - **Docs match the code:** README and every file in .context/ were checked against the code and updated (five roles, free configuration parameters instead of IO slots, no actor rules or flow versioning, exception mapping, rate limits, rich text with embedded files, branch/PR/CI workflow). codebase-map.md is rebuilt from the real layout, architecture.md is a real overview, operations.md gains the backup/restore and dead-letter procedures. Superseded ADRs get a one-line pointer; their bodies stay as history. - **CONTRIBUTING.md:** working rules, the path from branch to production, and short recipes for adding an endpoint, a column or table, a flow change, a notification, a frontend page and an npm package. Linked from the README. - **ESLint for the frontend** (TypeScript + React hooks rules, zero warnings allowed) with fixes for what it found: no setState inside effects, no ref written during render, complete effect dependencies. The contract list no longer lets a slow response for old filters overwrite newer results. - **CI:** a new frontend job runs npm ci, lint and build in node:24-alpine on every PR; the image build waits for it. - **Stale leftovers removed:** comments about the CTO role and IO slots, the unused SeededRoleIds class, "Cto" naming in demo data and tests. ## Testing - 237 backend tests pass, lint clean, frontend build OK. - The new frontend CI job runs for the first time on this PR. ## Deployment No migrations, no runtime changes beyond the contract list fix. Update the stack as usual (optional).
Adds ESLint with TypeScript and React hooks rules (npm run lint, zero warnings allowed) and fixes what it found: no setState inside effects (contract list keeps the query key with its result, practice prefill happens during render), a ref no longer written during render, and the search debounce effect lists its dependencies. A new frontend CI job runs npm ci, lint and build in node:24-alpine on every PR, so a lock file written by another npm version fails before merge; the image build waits for it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
CONTRIBUTING.md covers the working rules, the path from branch to production, and short recipes for adding an endpoint, a column or table, a flow change, a notification, a frontend page and an npm package.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Updates every doc to the code as it is now: five roles and who is on turn, free configuration parameters instead of IO slots, no actor rules or flow versioning (flow changes by migration through a PR), domain exceptions mapped in one place, remaining interfaces, rate limits and token pre-check, rich text with embedded files, branch/PR/CI workflow. codebase-map.md is rebuilt from the real layout, architecture.md becomes a real overview, operations.md gains the backup/restore and dead-letter procedures it promised, configuration.md lists the actual keys. Superseded ADRs get a one-line pointer; their bodies stay as history. README links the contributor guide.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
refactor: remove stale CTO and IO-slot leftovers from code and tests
All checks were successful
Build and publish Docker image / migrations-check (pull_request) Successful in 44s
Details
Build and publish Docker image / frontend (pull_request) Successful in 46s
Details
Build and publish Docker image / test (pull_request) Successful in 1m46s
Details
Build and publish Docker image / build-and-push (pull_request) Has been skipped
Details
851c474a68 
Drops the unused SeededRoleIds class, rewrites comments that still talked about the CTO role, IO positions or a deactivated rule that no longer exists, and renames the demo team and test helpers from Cto to Management. The role-migration test keeps the old role names on purpose.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
macoun merged commit 35bd234f5e into main 2026-10-16 07:14:36 +00:00
macoun deleted branch docs/handover-readiness 2026-10-16 07:14:36 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
STATOTEST/contract-microservice!3
No description provided.