feat: Add guild charters and task boards for various components
Some checks failed
Docs CI / lint-and-preview (push) Has been cancelled
Some checks failed
Docs CI / lint-and-preview (push) Has been cancelled
- Introduced guild charters for Scanner Deno, PHP, Ruby, Native, WebService, Java, Surface.Env, Surface.FS, Surface.Secrets, Surface.Validation, UI, Zastava Observer, Zastava Webhook, Zastava Core, and Plugin Platform. - Each charter outlines the mission, scope, required reading, and working agreements for the respective guilds. - Created task boards for Surface.Env, Surface.FS, Surface.Secrets, Surface.Validation, and Zastava components to track progress and dependencies. - Ensured all documents emphasize determinism, offline readiness, security, and integration with shared Surface libraries.
This commit is contained in:
28
src/UI/StellaOps.UI/AGENTS.md
Normal file
28
src/UI/StellaOps.UI/AGENTS.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# UI Guild Charter
|
||||
|
||||
## Mission
|
||||
Deliver a performant, accessible Angular console that surfaces Scanner/Policy/Zastava data, supports admin workflows, and remains offline-friendly. UI work must align with backend contracts, uphold design system standards, and maintain determinism for screenshots/tests.
|
||||
|
||||
## Scope
|
||||
- Angular workspace under `StellaOps.UI` (core modules, feature routes, shared components).
|
||||
- Integration with generated SDKs and Surface libraries (env configuration, auth tokens).
|
||||
- Cypress/Playwright automation, accessibility and performance tooling.
|
||||
- Theme assets, localisation scaffolding, and offline bundle preparation.
|
||||
|
||||
## Required Reading
|
||||
- `docs/modules/ui/README.md`
|
||||
- `docs/modules/ui/architecture.md`
|
||||
- `docs/modules/ui/implementation_plan.md`
|
||||
- `docs/modules/platform/architecture-overview.md`
|
||||
- `docs/15_UI_GUIDE.md`
|
||||
- `docs/18_CODING_STANDARDS.md`
|
||||
- Component-specific design docs referenced in `src/UI/StellaOps.UI/TASKS.md` (e.g., Link-Not-Merge, AOC dashboards)
|
||||
|
||||
## Working Agreement
|
||||
1. **State management**: update task status to `DOING`/`DONE` in both `docs/implplan/SPRINTS.md` and `src/UI/StellaOps.UI/TASKS.md` before starting/after finishing work.
|
||||
2. **Contract-first changes**: coordinate with API owners when modifying contracts; regenerate SDKs; update mocks and unit/e2e tests.
|
||||
3. **Accessibility**: adhere to WCAG 2.1 AA—run axe tests, ensure keyboard navigation, contrast, and localisation readiness.
|
||||
4. **Determinism**: stabilise timestamps/randomness in UI outputs so screenshots/tests remain reproducible; rely on fixture data.
|
||||
5. **Offline posture**: avoid CDN dependencies; ensure assets are hashed and referenced via environment configuration for Offline Kit.
|
||||
6. **Documentation**: update UI guides, screenshots, and help text when UX flows change; collaborate with Docs Guild for release notes.
|
||||
7. **Security**: enforce Authority scopes, handle token storage per architecture doc (DPoP, refresh); ensure no secrets in bundle.
|
||||
Reference in New Issue
Block a user