docs: 完善项目说明和注释
This commit is contained in:
@@ -0,0 +1,15 @@
|
||||
# access-manage Project Notes
|
||||
|
||||
This is a learning project for MySQL CRUD with Node.js, TypeScript, Fastify, and mysql2.
|
||||
|
||||
When working in this repository:
|
||||
|
||||
- Prefer explaining changes in Chinese because the project is being used for learning.
|
||||
- Keep examples close to the current code style: controller handles HTTP, service handles business rules, repository handles SQL.
|
||||
- Do not replace the direct `mysql2` SQL approach with an ORM; the goal is to learn tables, SQL, indexes, transactions, and parameterized queries.
|
||||
- Use `.env.development` for local development configuration.
|
||||
- Use Docker Compose only for local MySQL unless the user asks to containerize the Node.js app too.
|
||||
- Before changing database behavior, check `migrations/`, `src/db/`, and the related repository files.
|
||||
- When files or directories are added, removed, renamed, or reorganized, update `README.md` in the same change.
|
||||
- If `package.json` scripts change, update the README script explanation in the same change.
|
||||
- Use `.agents/skills/readme-structure-sync/SKILL.md` as the project skill for README and structure synchronization.
|
||||
Reference in New Issue
Block a user