Review checklist
Copy it into the merge request and tick what applies.
Boundaries
Section titled “Boundaries”- Changes stay in
plugins/<name>/, its e2e tests and its docs. Core changes go in their own merge request. - Imports only
@antfabric/*libraries and other plugins’ contracts packages. - Every route has
@Permissions(...)declared inplugin.yaml, or a deliberate@Public()that protects itself (settings switch, rate limit, no information leaks). - Who may see what is checked in the service on every call; hidden records answer “not found”.
- Migrations only added, never edited once applied; only the plugin’s schema.
-
dataClassandpiiinplugin.yamlmatch the personal data stored. - People and files referenced by id; no foreign keys outside the schema.
Contracts, events, notifications, workflows
Section titled “Contracts, events, notifications, workflows”- Contract changes are additive (minor version); breaking changes are a new major side by side.
- Contract calls are outside the caller’s transaction and handle
null(provider missing). - Events carry ids or small payloads, are addressed with
users, and are published in the change’s transaction. - Notifications have a stable idempotency key and never go to the person who acted.
- Workflows are deterministic; activities are safe to repeat.
Scale (the plugin runs on many replicas)
Section titled “Scale (the plugin runs on many replicas)”- No state that matters in process memory: data in your schema, limits through
PluginRateLimit, in-process caches only with a short TTL. - No
setIntervalor timers for periodic work:PluginJobs.every, or a schedule inplugin.yaml. - Anything longer than a request is a workflow; long CPU-bound steps use
queue: 'heavy'. - Event handlers (
events.on) are idempotent onevent.id; retried writes use@Idempotent()where clients retry them. - Contracts declared
optional: truewhen the plugin works without the provider; actors come fromcaller.actor(), not from the caller.
Screens
Section titled “Screens”- Every platform in
targetsworks: web, desktop, phone, App Admin. - Other screens are opened by route id; no hand-built URLs.
- UI kit components and tokens; dark mode and narrow screens checked.
- Logic shared through
shared/, not copied between web and phone.
Quality
Section titled “Quality”- Unit tests for the rules; end-to-end tests for access, events and notifications.
-
pnpm plugins:check --bootpasses (manifests valid, and the API and workers start with your plugin: no missing provider, no import cycle);pnpm api:specrun and committed when routes or DTOs changed. - README and docs updated; demo data updated when the data model changed.