Skip to content

docs: add "Why pistachio?" section to README#235

Merged
winebarrel merged 1 commit into
mainfrom
claude/add-readme-why-section-ATIg5
May 20, 2026
Merged

docs: add "Why pistachio?" section to README#235
winebarrel merged 1 commit into
mainfrom
claude/add-readme-why-section-ATIg5

Conversation

@winebarrel
Copy link
Copy Markdown
Owner

Summary

  • Add a Why pistachio? section near the top of the README (right after the intro and "Getting Started" link, before Installation).
  • Frames the motivation against hand-written migration files and highlights four pillars: declarative editing, plain-SQL files with pista dump round-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

  • Render the README on GitHub and confirm the new section appears in the intended location with correct Markdown formatting.

https://claude.ai/code/session_01PpzYzcj7YYUVnieiUTCTVv


Generated by Claude Code

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
Copilot AI review requested due to automatic review settings May 20, 2026 15:50
@codecov
Copy link
Copy Markdown

codecov Bot commented May 20, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.94%. Comparing base (e7e0f8d) to head (e0a6771).

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           
Flag Coverage Δ
pg15 91.90% <ø> (ø)
pg16 91.90% <ø> (ø)
pg17 91.90% <ø> (ø)
pg18 91.94% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 dump round-trip, opt-in destructive changes with visible -- skipped: output, and online/production apply controls like CONCURRENTLY and --with-tx).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
@winebarrel winebarrel merged commit 9ecd733 into main May 20, 2026
14 checks passed
@winebarrel winebarrel deleted the claude/add-readme-why-section-ATIg5 branch May 20, 2026 15: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.

3 participants