Merge pull request 'docs: public-safe AGENTS writing-docs link' (#16) from chore/agents-public-link into main

2026-08-06 10:15:03 -05:00
parent 4279badc5d 54e5698649
commit 6beb051fda
1 changed files with 20 additions and 0 deletions
@@ -0,0 +1,20 @@
+# AGENTS.md — playkit
+
+Short orientation for Cursor agents. Prefer this over rediscovering the repo.
+
+## Defaults
+
+- Read `README.md` for run/install; use `make help` when a Makefile exists.
+- Lint and tests are **hard gates** in CI — never add `|| true` to them.
+- **Do not** commit secrets; app creds live in Infisical (`secrets.levkin.ca`, `/apps/playkit`).
+- Multi-step or ambiguous work → Plan mode first, then Agent mode.
+
+## Docs voice
+
+READMEs/guides: [writing-docs.md](https://github.com/Gitilia/project-template/blob/main/docs/writing-docs.md) (no emoji decoration).
+
+## Close-out
+
+1. Run the narrowest verify that fits (`make test`, `npm test`, `pytest`, CI workflow locally).
+2. Public GitHub mirror (`Gitilia/*`): after README/docs release merges, sync mirrors — see `ansible/docs/guides/github-mirrors.md`.
+3. Non-trivial PR: offer review; merge only when the user asks.