Repository navigation
Add a guideline for database schema and index changes - #6140
Merged
danielmarbach merged 1 commit intoNov 16, 2026
Merged
Conversation
Moves the guideline proposed in Particular/Platform#1662 into the public engineering context of the repository it applies to, as suggested in its review. It is adapted for a public repository: links to private records are replaced by the public ADR and testing docs, the customer reference is removed, and the relational migration section reflects that migrations run during setup and a normal start fails when migrations are pending. Rule 5 also names the SlowMigrationOperationApprovals test for the relational persisters.
danielmarbach
approved these changes
Nov 16, 2026
danielmarbach
deleted the
database-schema-and-index-changes-guideline
branch
November 16, 2026 16:03
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.
Moves the guideline proposed in Particular/Platform#1662 by @ramonsmits into the public engineering context of ServiceControl, as suggested in the review of that pull request. The guideline applies only to ServiceControl, and the engineering context template places repository guidelines under
docs/guidelines/, listed in the Guidelines section ofdocs/README.md.Changes
docs/guidelines/database-schema-and-index-changes.md: the guideline. An index or schema change is a breaking change; ship it in a major release, or opt-in in a minor; record it in the upgrade guide in the same pull request; keep the approval tests current; and a pull request checklist.docs/README.md: a new Guidelines section that lists it, following the engineering context template.docs/testing.md: theIndexDefinitionApprovalsparagraph links the guideline.Differences from Particular/Platform#1662
--setup), which installing and upgrading run, not at every start-up. A normal start fails when migrations are pending (Add startup checks to application hosts to fail early on body storage and database migrations #6061). The guideline says so.SlowMigrationOperationApprovalsfor SQL Server and PostgreSQL next toIndexDefinitionApprovals, instead of the migration and model snapshot alone.Particular/Platform#1662 can then keep only its definition of done item, pointing here.