Skip to content

feat!: settle the public contract before 1.0 - #48

Merged
hazeliscoding merged 4 commits into
mainfrom
feat/contract-review
Oct 20, 2026
Merged

hazeliscoding merged 4 commits into
mainfrom
feat/contract-review

Conversation

@hazeliscoding

Copy link
Copy Markdown
Owner

The last review of the public contract before 1.0 (ROADMAP, 2026-10-20): every page and feed URL pattern, the id rules and every field in data/README.md.

Changed

  • A slug must match its id, so a page's URL keeps the id's promise never to change (all 85 already did).
  • Conventions lose city and region. The site never read them and nothing checked them against the editions. The 35 convention records were approved and promoted; the schema now rejects the fields.
  • data/README.md lists every field, the id rules (including a second edition in the same city and year), and that published records are never renamed or deleted.

Kept

  • Feed names (feeds/north.ics) and region page slugs (/regions/north-texas/) stay as they are; renaming would break subscribers or links.
  • Month pages (/calendar/YYYY-MM/) are a rolling window, outside the stable contract.

Moving

Breaking changes for the v1.0.0 notes: convention records no longer have city or region; read them from the editions.

Checked locally: 85 unit tests, 152 e2e tests, typecheck, lint, data:validate.

Closes #38

The site never read them and nothing checked them against the editions,
so they could drift. Editions already say where each one takes place,
including every city a touring convention visits.

BREAKING CHANGE: convention records no longer have `city` or `region`.
Read them from the convention's editions instead.
@hazeliscoding
hazeliscoding merged commit 939b264 into main Oct 20, 2026
2 checks passed
@hazeliscoding
hazeliscoding deleted the feat/contract-review branch October 20, 2026 23:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Review URLs, feeds, ids and the data format before 1.0

1 participant