1.2 KiB
1.2 KiB
name, description
| name | description |
|---|---|
| readme-structure-sync | Use this skill whenever files or directories are added, removed, renamed, or reorganized in the access-manage project. It ensures README.md stays synchronized with the actual project structure and package scripts. |
README Structure Sync
When the project file structure changes, update README.md in the same change.
Required checks
- Run
rg --files -g '!node_modules' -g '!dist'to inspect the current repository structure. - If a directory or important file was added, removed, renamed, or moved, update the README directory section.
- If
package.jsonscripts changed, update the README script section. - Keep explanations practical: describe what each directory or important file is used for.
- Run
pnpm typecheckafter documentation-related changes when TypeScript source was also touched.
README sections to keep current
目录结构package.json 脚本说明启动步骤数据库迁移说明
Standard
The README should help a new developer understand:
- where API routes live,
- where business rules live,
- where SQL lives,
- how to start MySQL,
- how to run migrations,
- how to start and verify the backend.