27 lines
2.0 KiB
Markdown
27 lines
2.0 KiB
Markdown
# ZitPlane — contributor and AI-agent instructions
|
|||
|
|
|
||
|
|
## Project boundaries
|
||
|
|
- Official ZITADEL Go backend is an external, version-pinned image. Do not vendor, fork or modify its core source.
|
||
|
|
- `auth/ui/v2/` owns login frontend presentation; `users/ui/` owns the user portal.
|
||
|
|
- Authentication, OAuth/OIDC callbacks, MFA, passkeys, sessions and token/security behavior are **protected logic**.
|
||
|
|
- App-specific billing, product permissions, usage and license logic belong in the individual apps, not ZitPlane.
|
||
|
|
|
||
|
|
## Phase rules
|
||
|
|
1. Inspect Git status and read `docs/PHASES.md` before editing.
|
||
|
|
2. Require an explicitly approved scope before each new phase; stay within its exact allowed paths.
|
||
|
|
3. Do not add fake runnable scaffolds, dependency versions, secret values or speculative upstream imports.
|
||
|
|
4. On UI-only tasks edit components, styles and approved assets only; preserve auth flows and API contracts.
|
||
|
|
5. Mock previews and test identities must be confined to development/test; never enable auth bypass in production.
|
||
|
|
6. Run one focused verification, inspect exact diff, update relevant docs, and make one local Git commit per approved phase.
|
||
|
|
7. Never push, deploy, create tags, access real user accounts or alter production without explicit approval.
|
||
|
|
|
||
|
|
## Security and portability
|
||
|
|
- No credentials, master keys, database data, cert private keys, session tokens or `.env` in Git.
|
||
|
|
- Production configuration must fail closed if required secrets, HTTPS or storage configuration are absent.
|
||
|
|
- Lock external image versions and upstream Login V2 revision; document upgrade procedure.
|
||
|
|
- Prefer readable React/TypeScript components, accessibility, responsive layouts and small reusable tokens.
|
||
|
|
- Never modify upstream authentication machinery to accommodate an AI-generated UI without a separate security-approved scope.
|
||
|
|
|
||
|
|
## Developer experience
|
||
|
|
- Keep README files accurate for the current phase. Do not claim an app runs before it is integrated.
|
||
|
|
- Develop on local/test ZITADEL and synthetic users. Verify OIDC, MFA/passkey and redirect flows before release.
|