Skip to content
AntFabric Corev1.0.0local

Review checklist

Copy it into the merge request and tick what applies.

  • 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 in plugin.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.
  • dataClass and pii in plugin.yaml match 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.
  • No state that matters in process memory: data in your schema, limits through PluginRateLimit, in-process caches only with a short TTL.
  • No setInterval or timers for periodic work: PluginJobs.every, or a schedule in plugin.yaml.
  • Anything longer than a request is a workflow; long CPU-bound steps use queue: 'heavy'.
  • Event handlers (events.on) are idempotent on event.id; retried writes use @Idempotent() where clients retry them.
  • Contracts declared optional: true when the plugin works without the provider; actors come from caller.actor(), not from the caller.
  • Every platform in targets works: 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.
  • Unit tests for the rules; end-to-end tests for access, events and notifications.
  • pnpm plugins:check --boot passes (manifests valid, and the API and workers start with your plugin: no missing provider, no import cycle); pnpm api:spec run and committed when routes or DTOs changed.
  • README and docs updated; demo data updated when the data model changed.