Contributing

Urmate is moving quickly. Good contributions are small enough to review, connected to real data, and respectful of existing dashboard patterns.

Workflow

1. Read the nearby files before editing.
2. Check existing API and component patterns.
3. Keep changes scoped to the requested feature.
4. Add or update tests when behavior changes.
5. Run the relevant commands.
6. Document env vars, migrations, webhooks, or setup steps.

Before Editing

cd /root/apps/urmate
git status --short
rg "feature name or route"

Never revert unrelated user work. If a file already has changes you did not make, read it carefully and preserve the user's work.

Documentation Workflow

Docs now live in /root/apps/docus. Update docs when you add:

• routes;
• env variables;
• API families;
• role/permission rules;
• external integration setup;
• deployment steps;
• admin controls;
• user-facing workflows.

Run the docs build after major content edits:

cd /root/apps/docus
pnpm run docs:build