6.0 KiB
Repository Instructions
SHD design-system maintenance
Treat docs/DESIGN_SYSTEM.md and the shared tokens and patterns in src/app.css
as maintained parts of the product.
Whenever a change makes a significant visual or interaction-design decision, update the design system in the same change. This includes:
- introducing or changing colors, typography, spacing, borders, elevation, or motion;
- creating a new reusable layout, navigation, table, editor, form, card, status, or feedback pattern;
- materially changing dashboard density, hierarchy, responsive behavior, or accessibility behavior;
- changing the semantic meaning of an existing visual state;
- establishing a pattern that future pages or components should follow.
For significant design changes:
- Reuse or extend the CSS custom properties in
src/app.css; do not scatter near-duplicate hard-coded values throughout new components. - Update
docs/DESIGN_SYSTEM.mdwith the new or revised rule, token, pattern, usage guidance, and responsive or accessibility considerations. - Refactor repeated UI into a reusable component when that makes the pattern clearer and reduces divergence.
- Preserve the SHD design principles: tactical but restrained, data-first, square and engineered, orange reserved for action and emphasis, and explicit textual state indicators.
- Verify hover, pressed, focus-visible, pending, disabled, error, success, and reduced-motion behavior where applicable.
- Run
npm run checkandnpm run buildbefore completing the change.
Minor alignment fixes, isolated bug fixes, and corrections that do not introduce or revise a reusable design decision do not require a documentation update.
If uncertain whether a visual change is significant, update the design system.
ISAC editor lifecycle
All ISAC data-management editors must follow the same successful-save behavior:
- Saving an edit to an existing record closes the editor and returns the user to the registry.
- Saving a newly added record keeps the editor open with a fresh blank record so consecutive data entry remains fast.
- Validation errors keep the editor open and preserve the entered values.
- Server actions must return the add/edit mode and a unique result token; client-side reactive handling must consume each token only once to avoid repeated state updates.
Apply this convention whenever an ISAC editor is added or materially changed.
ISAC audit logging
Every successful server-side mutation performed through ISAC must create an append-only audit event. Audit coverage is a required part of implementing or changing any ISAC module, action, endpoint, bulk operation, moderation control, identity operation, access-policy change, archive action, or destructive action.
Follow these rules:
- Use the shared audit utilities in
src/lib/server/audit.ts; do not invent module-specific audit formats or write directly toaudit_login new code. - Record the authenticated operator ID, stable category, specific action, target entity ID, timestamp, and useful before/after snapshots.
- Categories describe durable operational domains such as
game_data,user_access,user_moderation,identity, androle_management. Actions describe the exact event in namespaced past tense, such asweapon.updated,attribute.archived, ormoderation.blocked. - Capture relationship changes as well as the primary row. When an action replaces permission sets, compatible brands, talents, effects, tiers, or other linked records, include the meaningful previous and resulting sets.
- Create audit records only after validation succeeds and the requested mutation has completed. Rejected, unauthorized, or validation-failed requests must not appear as successful mutation events.
- Never include password hashes, session tokens, magic-link tokens, OAuth state, passkey public-key bytes, SMTP credentials, environment secrets, or other authentication secrets in audit snapshots. Minimize personal data to what is necessary for security, support, and accountability.
- Audit visibility is controlled by
audit.view. The read-onlyAuditorrole grantsisac.accessandaudit.view; it must not implicitly grant mutation, moderation, identity-management, or user-access permissions. - New audit categories and actions must remain searchable in the Audit History registry. Update its grouped filters when a new durable operational domain is introduced.
- Preserve audit history during normal record archival and soft deletion. Never add an ISAC action that edits or deletes audit records without an explicit retention policy, legal review, and separately audited authority.
- Tests and handoff verification for an ISAC mutation must include confirming that its audit event contains the correct actor, category, action, target, and change evidence.
Database preservation
Development data is valuable and may be entered by non-technical contributors. Treat embedded database files as persistent user data, not disposable build artifacts.
Before deleting, replacing, recreating, renaming, or destructively migrating a
database—and before any major schema change—create a timestamped JSON backup
with npm run db:backup.
Database work must follow these rules:
- Confirm which environment and exact database path are in scope.
- Stop processes that hold the embedded database lock before backup or restore.
- Create and verify a JSON backup before destructive work.
- Never overwrite or delete the only available backup.
- Keep backups out of Git; they can contain user records and password hashes.
- Prefer additive, repeatable schema migrations over database recreation.
- After a restore, run the schema migration and verify record counts and critical entities before resuming data entry.
- Report the backup path when completing database-destructive work.
Use npm run db:restore -- <backup-file> only with an empty, migrated target
database. The restore script intentionally refuses to merge into a populated
database.