[FEATURE] Diff and preserve comments

Open
#207 0 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
go, postgresql
Domain
databases

Research direction

Start by locating the schema-diff and planning entry points, then trace how database objects become generated SQL migrations. Determine how comments should be represented and preserved across diffing, planning, and migration generation; done means comments on database objects survive the full workflow.

Written by the indexing model from the issue text.

Description

enhancement
Describe the feature

Have pg-schema-diff accommodate comments on database objects in its diffing, planning, etc.

Motivation

Preserving technical commentary is essential to human understanding of the database. "Make it easier on the next guy, it's probably you!"

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.