Skip to content

Commit 26ea858

Browse files
committed
docs(README): update database migration descriptions
- Change "Versioned Schema Evolution" to "PR-Driven Schema Evolution" - Update migration naming to use Pull Request merge date, summary, and ID - Add traceability with links to originating code changes - Improve clarity and emphasis on saying goodbye to manual updates
1 parent 1563cd6 commit 26ea858

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,10 +99,10 @@ Click on any category to explore.
9999
---
100100

101101
### 🔄 Automated Database Migrations
102-
- **Versioned Schema Evolution:** Implements a robust, versioned database migration system that automatically applies schema changes to MongoDB on application startup.
102+
- **PR-Driven Schema Evolution:** Implements a robust, versioned database migration system that automatically applies schema changes to MongoDB on application startup.
103103
- **Idempotent & Generic:** Each migration is idempotent and designed to handle schema evolution for *any* model in the database, ensuring data consistency across deployments.
104-
- **Date-Time Based Versioning:** Migrations are named using a `YYYYMMDDHHMMSS__<description>.dart` format, guaranteeing chronological execution and clear context.
105-
> **Your Advantage:** Say goodbye to manual database updates! Your application gracefully handles schema changes, providing a professional and reliable mechanism for evolving your data models without breaking existing data.
104+
- **Traceable Versioning:** Migrations are identified by their Pull Request merge date (`prDate` in `YYYYMMDDHHMMSS` format) for chronological execution, a concise `prSummary`, and a direct `prId` (GitHub PR ID) for full traceability.
105+
> **Your Advantage:** Say goodbye to manual database updates! Your application gracefully handles schema changes, providing a professional and reliable mechanism for evolving your data models without breaking existing data, with clear links to the originating code changes.
106106
107107
</details>
108108

0 commit comments

Comments
 (0)