docs(pr): require safe alembic consolidation - #21
Open
cjber wants to merge 1 commit into
Open
Conversation
Reviewer's guide (collapsed on small PRs)Reviewer's GuideThis PR updates the PR skill guide to require safe consolidation of unpublished Alembic migrations as the final repository change before last verification, with strict rules to preserve migration integrity and avoid touching potentially shipped or shared revisions. Flow diagram for safe Alembic consolidation in PR workflowflowchart TD
Start[Before last PR verification]
FetchMain[Fetch origin/main and merge main into task branch]
Consolidate[Safely consolidate unpublished Alembic revisions from this PR]
Preserve[Preserve operation order, upgrade/downgrade behavior, data backfills, ancestry, and a single head]
CheckStatus{Revision possibly shipped/shared or status uncertain?}
Skip[Leave revision intact and document why consolidation was unsafe]
Verify[Run full gate and final validation]
Start --> FetchMain --> Consolidate --> Preserve --> CheckStatus
CheckStatus -->|Yes| Skip --> Verify
CheckStatus -->|No| Verify
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
Bugbot is not enabled for your account, so this pull request was not reviewed. Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs. |
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- Consider clarifying what qualifies as an “unpublished” Alembic revision (e.g., not applied to any shared environment) to reduce ambiguity for contributors deciding whether consolidation is safe.
- The phrase “minimum coherent revision set” is somewhat abstract; adding a brief, concrete criterion (e.g., no gaps, single head, no behavioral changes) would help readers consistently apply this guidance.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider clarifying what qualifies as an “unpublished” Alembic revision (e.g., not applied to any shared environment) to reduce ambiguity for contributors deciding whether consolidation is safe.
- The phrase “minimum coherent revision set” is somewhat abstract; adding a brief, concrete criterion (e.g., no gaps, single head, no behavioral changes) would help readers consistently apply this guidance.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
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.
Why
Keep unpublished migration history concise before PR handoff without rewriting revisions that may already be deployed or shared.
Summary
Test plan
Summary by Sourcery
Documentation: