菜单
Which document to update for a given behaviour change in this repo. Use at the end of any change that alters endpoints, domain rules, schema, packages, wiring, or features — docs/ is a first-class deliverable and must ship in the same PR.
默认使用会先检查来源的 Prompt；你也可以切换为直接命令，或下载本地副本。
决定是否安装前，请先阅读 SKILL.md，以及 SkillsMP 当前展示的配套文件。
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
直接命令不会经过审查 Prompt；运行前请先检查来源。
npx skills add https://github.com/fjaeckel/ninerlog-api --skill docs-sync命令会保持在同一行。复制前请横向滚动并检查完整内容。
想先保存到本地？可下载 SkillsMP 当前能够提供的文件。
The OpenAPI-first workflow for this repo. Use whenever adding, removing, or changing an HTTP endpoint, request/response field, status code, query parameter, or auth requirement — and before touching anything under internal/api/generated/ or api-spec/openapi.yaml.
Database schema changes in this repo — creating golang-migrate migration pairs, naming and numbering rules, the reversible-down requirement, the test-DB init script, and repository/model follow-up. Use whenever adding a table, column, index, or constraint.
How to write and run tests in this repo — unit vs integration vs e2e, the build tags and env vars each tier needs, running a single test, and the pre-commit gate. Use before writing a test, running the suite, or claiming work is done.
基于 SOC 职业分类
正在显示 SKILL.md
| name | docs-sync |
| description | Which document to update for a given behaviour change in this repo. Use at the end of any change that alters endpoints, domain rules, schema, packages, wiring, or features — docs/ is a first-class deliverable and must ship in the same PR. |
Documentation in docs/ is part of the codebase. A change is not complete until its
documentation matches reality. Update in the same PR:
| Changed | Update |
|---|---|
| HTTP contract / endpoints | api-spec/openapi.yaml, docs/API.md, docs/FEATURES.md |
| Domain rules (flights, currency, validation, time handling) | docs/DOMAIN.md |
| Entities, schema, migrations | docs/DATA_MODEL.md |
| Packages, responsibilities, startup wiring | docs/PACKAGES.md, docs/ARCHITECTURE.md |
| A product feature added/removed/changed | docs/FEATURES.md |
| Auth, metrics, performance, test tooling | docs/AUTHENTICATION.md, docs/METRICS.md, docs/PERFORMANCE.md, docs/RUNNING_TESTS.md |
| Developer workflow / commands | docs/DEVELOPMENT.md, CONTRIBUTING.md, README.md |
Guidelines:
internal/api/generated/) —
regenerate them.docs/DEVELOPER_GUIDE.md is the entry point and documentation map; keep its links valid..github/copilot-instructions.md is stale and contradicts the codebase in places
(TypeScript/Prisma/sqlc examples). Do not treat it as a source of truth; if you touch it,
correct it toward docs/.