القائمة
Documentation file naming for the Boilerplate repo. Use when creating or modifying docs, README, or markdown.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
When changing API routes, auth, or env-dependent behavior, add or update the corresponding integration tests and keep the test file layout consistent.
When adding or changing files under infra/k8s/ or sync targets for k8s, know what Argo CD syncs and remind the user to push to Git so the cluster can sync.
Keeps tools/generate-data seeders and docs in sync when main or management DB schema or ORM entities change. Use when adding or changing tables/entities in packages/orm, packages/management-orm, or infra database migrations.
When changing DB schema or permission dimensions, consider predefined roles and bucket_role / role-related code.
Use when adding or changing environment variables, infra/env/classification YAML, scripts/env-classification, K8s env render, or local env generation.
Common patterns for the Boilerplate HTTP API (Express)
| name | boilerplate-documentation-conventions |
| description | Documentation file naming for the Boilerplate repo. Use when creating or modifying docs, README, or markdown. |
| version | 1.1.0 |
README.md at repository root.README.md). Subdirectories must use descriptive names (e.g. scripts/github/SCRIPTS-GITHUB.md, not README.md).Name after the full path from root (uppercase, slashes → hyphens):
apps/api/ → APPS-API.mdapps/web/ → APPS-WEB.mdinfra/k8s/ → INFRA-K8S.mdpackages/ui/ → PACKAGES-UI.mdscripts/github/ → SCRIPTS-GITHUB.md.llm/ → LLM.mdPattern: [FULL-PATH-WITH-HYPHENS].md. Do not add multiple README.md files per directory.
INDEX.md in the repo is .cursor/skills/INDEX.md (skills quick reference). All other directory overviews use the full-path name (e.g. INFRA-K8S.md, PACKAGES-UI.md)..llm/plans/ use 00-overview.md or 00-master-plan.md, not INDEX.md or README.md.