Create guidelines for declarative schema setup

Open
#45 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
go, postgres, sql
Domain
databases, documentation

Research direction

No file, test, or entry point is named in the issue. Start by reviewing the library's existing usage and schema-diff examples, then document where declarative SQL belongs, how changes should be tested, and what a complete example looks like.

Written by the indexing model from the issue text.

Description

documentation

We should create a set of guidelines (or examples) for folks who want to use the library to declaratively manage their database schema's in a project, e.g., where should folks put their SQL files, how should they test changes, etc.

Dominant language
Go
Stars
884
Forks
82
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from stripe/pg-schema-diff

All issues in stripe/pg-schema-diff

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.