docs: add "Why pistachio?" section to README#235
Merged
Conversation
Explain the motivation for choosing pistachio over hand-written migration files, highlighting its declarative pure-SQL workflow, safe-by-default drop suppression, and production-oriented apply controls. https://claude.ai/code/session_01PpzYzcj7YYUVnieiUTCTVv
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #235 +/- ##
=======================================
Coverage 91.94% 91.94%
=======================================
Files 50 50
Lines 5425 5425
=======================================
Hits 4988 4988
Misses 230 230
Partials 207 207
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new “Why pistachio?” section near the top of the README to better explain the tool’s motivation and differentiators (declarative workflow, plain-SQL schema source of truth with dump round-trip, safe-by-default drop suppression visibility, and production-aware apply controls).
Changes:
- Introduces a “Why pistachio?” section immediately after the intro / Getting Started link.
- Highlights four core value pillars (declarative editing,
pista dumpround-trip, opt-in destructive changes with visible-- skipped:output, and online/production apply controls likeCONCURRENTLYand--with-tx).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Summary
pista dumpround-trip, safe-by-default drop suppression (--allow-drop/-- skipped:), and production-aware apply controls (CONCURRENTLY,--with-tx,--pre-sql/lock_timeout).The framing was informed by how comparable declarative tools (sqldef, Atlas, Skeema) present their value, while emphasizing pistachio's differentiators (drop suppression visibility, online-apply controls, dump round-trip).
Test plan
https://claude.ai/code/session_01PpzYzcj7YYUVnieiUTCTVv
Generated by Claude Code