Skip to content

Change notes

A change note marks a risky change on the board: a migration, a breaking API change, data loss or a new dependency. It sits on the database node and on every node whose code reads what changed, so a reviewer sees the risk without reading the SQL.

A migration on customers-db shows the dropped name column and a reader that still depends on it

The migration demo puts the schema change beside its affected readers.

Write the migration that drops customers.name. Flag it on the board and cite every reader of that column.
  • add_code_ref cites the migration file first; the note hangs off that ref.
  • add_change_note records the kind of change and whether it is destructive. It lists the migration steps, including the irreversible step. It also records changed columns and the readers the agent found.
  • add_code_ref cites each reader. A reader the agent did not update shows as one that will break.

The board flags nodes the change touches. Select one to inspect its readers, numbered steps and stale reader locations. Use mark reviewed to record your review.

  • The board knows only the readers the agent cites. It does not search your repo for others.
  • It flags; it never blocks a commit, merge or deploy.

Tools: add_change_note, update_change_note, remove_change_note.