Skip to content

docs: add OpenClockwork agent guidelines #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
patrickschiller merged 1 commit into from
Jun 16, 2026
Merged

docs: add OpenClockwork agent guidelines #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,15 @@
- The `nx-generate` skill handles generator discovery internally - don't call nx_docs just to look up generator syntax

<!-- nx configuration end-->

# OpenClockwork Project Guidelines

- OpenClockwork is a public Apache-2.0 project. Keep repository metadata, README, FEATURES, CONTRIBUTING, SECURITY, and NOTICE consistent with that public-facing posture.
- Preserve the Contributor rules: external contributions require DCO sign-off (`Signed-off-by:`) and the DCO GitHub Action should remain active unless the project policy is intentionally changed.
- Use `pnpm` for package-management commands and keep the pinned toolchain aligned with `package.json` (`Node 20+`, `pnpm 9+`).
- Treat the Prisma schema and migrations as the source of truth for database changes. Add new migrations for schema changes; do not edit migrations that have already been merged to `main`.
- The backend follows NestJS conventions: controllers stay thin, services own business logic, and API changes should keep the OpenAPI spec and generated web client in sync.
- The frontend is a React/Vite/Tailwind PWA with German and English UI support. User-facing text should go through the existing i18n catalogue instead of hard-coded strings.
- Time tracking, leave, approval, break deduction, and core-hour rules model real working-time behavior. Read the existing domain tests before changing these rules, and add focused tests for behavioral changes.
- Never commit secrets, real personal data, production credentials, or local Azure parameter files. Keep demo data synthetic and make privacy implications explicit in public documentation.
- Prefer small, reviewable changes that preserve the existing monorepo boundaries between `apps/api`, `apps/web`, `apps/*-e2e`, `libs/shared`, `prisma`, and `infra`.