Creating a FAQ/Troubleshooting Doc

Open
#156 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
postgresql, sql
Domain
databases, documentation

Research direction

No documentation file or test is named. Locate the FAQ or troubleshooting documentation, then verify the proposed guidance about declarative SQL schemas and --include-schema behavior; done means these troubleshooting items are clearly documented in the appropriate place.

Written by the indexing model from the issue text.

Description

Some items maybe worth including on this doc:

Declarative SQL schemas

  • SQL does not need to be idempotent. Only needs to be able to run on fresh databases

Missing schema objects

Make sure the schema is actually being diffed. For example, if --include-schema is specified, public is not diffed by default, meaning any objects created in the public schema will be ignored.

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.