Skip to content

Docs: clarify migrations almost always belong in the engine #130

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
HamptonMakes merged 1 commit into from
Jun 9, 2026
Merged

Docs: clarify migrations almost always belong in the engine #130

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@ Most of the application logic lives in the **CoPlan Rails engine** (`engine/`),
- **Policies** — authorization policies in `engine/app/policies/coplan/`
- **Jobs** — background jobs in `engine/app/jobs/coplan/`
- **Views, helpers, assets, JS** — all Hotwire views and Stimulus controllers
- **Migrations** — engine-owned tables go in `engine/db/migrate/`
- **Migrations** — engine-owned tables go in `engine/db/migrate/`. Data/backfill migrations supporting engine behavior also belong here (the gem only packages `engine/`, so host-only migrations don't reach gem consumers); copy them into the host with `bin/rails co_plan:install:migrations`.
- **Routes** — engine routes in `engine/config/routes.rb`, mounted by the host

### Host app (top-level) — thin deployment shell
- **ActiveAdmin** — admin registrations in `app/admin/`
- **Auth** — `SessionsController`, `User` model (legacy, being migrated to `CoPlan::User`)
- **App-specific integrations** — `SlackClient`, `SlackNotificationJob`
- **Migrations** — only for data migrations, FK rewiring, or host-specific tables in `db/migrate/` (the engine owns schema for `coplan_*` tables)
- **Migrations** — this app is just the example/demo host, so `db/migrate/` mostly holds the `*.co_plan.rb` copies of engine migrations (the engine owns schema for `coplan_*` tables)
- **Config** — database, deployment, environment, seeds

**When adding new features, put them in the engine** unless they are deployment- or host-specific (admin UI, external integrations, auth).
Expand Down
Loading