yesodweb / yesodweb/persistent

Migrations should be able to report *why* it is migrating

Open
#1,510 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Haskell
Stars
486
Forks
306
PR merge metrics
No merged PRs in 30d

Description

Migrations will report "what to do" in order to bring something up to spec, but they don't report "why."

For some casees, (ie add column or create table) this is straightforward - the thing didn't exist previously. But for alter, we should have enough information to determine why a migration is necessary - "the constraint is spelled wrong" is distinct from "the types are wrong."

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.

Research direction

Start by tracing how migrations currently report what to do, especially the alter case, and identify where schema differences are classified. Done means migration output distinguishes why an alteration is needed, such as a misspelled constraint versus an incorrect type.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
databases
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.