Skip to content

docs: align README with concurrency model and testing strategy#12

Merged
heitorrsdev merged 1 commit intomainfrom
docs/update-readme-with-concurrency-and-testing
Feb 27, 2026
Merged

docs: align README with concurrency model and testing strategy#12
heitorrsdev merged 1 commit intomainfrom
docs/update-readme-with-concurrency-and-testing

Conversation

@heitorrsdev
Copy link
Owner

Description

This PR updates the README to reflect the current architectural state of the project after the introduction of database-enforced concurrency guarantees and the formalization of the testing strategy.

It removes outdated sections and ensures that the documentation accurately represents the system’s integrity model, layered architecture, and SQL-first approach.


What was done

  • Rewrote README in English to align with project standards
  • Removed the Current Status section to avoid documentation drift
  • Updated architecture description to reflect enforced dependency rules
  • Clarified database-level invariant enforcement strategy
  • Documented concurrency validation approach at a high level
  • Linked explicitly to testing.md for detailed concurrency and integration testing strategy
  • Ensured README focuses on stable architectural foundations rather than transient implementation state

Why

  • The previous README no longer reflected the current concurrency model and testing guarantees
  • The Current Status section introduced maintenance overhead and risk of desynchronization
  • Documentation should emphasize architectural invariants and long-term design decisions, not temporary development state
  • A stable, principle-driven README reduces churn and improves long-term clarity

Notes

  • This PR does not introduce functional changes
  • All behavioral and concurrency guarantees are already covered by integration tests
  • Detailed architectural decisions remain documented in docs/adr

@heitorrsdev heitorrsdev merged commit 6e6fc4c into main Feb 27, 2026
1 check passed
@heitorrsdev heitorrsdev deleted the docs/update-readme-with-concurrency-and-testing branch February 27, 2026 17:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant