Simplify system implementation
This commit is contained in:
@@ -21,24 +21,29 @@ the rest conversationally.
|
||||
|
||||
## Status (update the checkboxes as you complete each item)
|
||||
|
||||
- [ ] Fill backend guidelines
|
||||
- [ ] Fill frontend guidelines
|
||||
- [ ] Add code examples
|
||||
- [x] Fill backend guidelines
|
||||
- [x] Fill frontend guidelines
|
||||
- [x] Add code examples
|
||||
|
||||
## Analysis Notes
|
||||
|
||||
- 后端当前没有数据库、迁移、持久化客户端或实际日志实现,因此移除了 `database-guidelines.md` 和 `logging-guidelines.md` 模板;相关能力出现时应先建立真实实现和对应规格。
|
||||
- 规格以 `zhixing-server/src/`、`zhixing-server/tests/`、`zhixing-web/src/`、项目 README 和 ADR 为依据,GitNexus/ABCoder 索引未在本环境中可用。
|
||||
|
||||
---
|
||||
|
||||
## Spec files to populate
|
||||
## Spec files populated
|
||||
|
||||
|
||||
### Backend guidelines
|
||||
|
||||
| File | What to document |
|
||||
|------|------------------|
|
||||
| `.trellis/spec/backend/directory-structure.md` | Where different file types go (routes, services, utils) |
|
||||
| `.trellis/spec/backend/database-guidelines.md` | ORM, migrations, query patterns, naming conventions |
|
||||
| `.trellis/spec/backend/error-handling.md` | How errors are caught, logged, and returned |
|
||||
| `.trellis/spec/backend/logging-guidelines.md` | Log levels, format, what to log |
|
||||
| `.trellis/spec/backend/quality-guidelines.md` | Code review standards, testing requirements |
|
||||
| `.trellis/spec/backend/directory-structure.md` | 包结构、bounded context 和导入边界 |
|
||||
| `.trellis/spec/backend/configuration-and-runtime.md` | Settings、应用工厂和部署环境 |
|
||||
| `.trellis/spec/backend/http-api-contracts.md` | 路由组合、响应模型和同源 API 路径 |
|
||||
| `.trellis/spec/backend/error-handling.md` | 当前 FastAPI 错误行为及跨层错误传递 |
|
||||
| `.trellis/spec/backend/quality-guidelines.md` | Ruff、Pyright、pytest 及禁止模式 |
|
||||
|
||||
|
||||
### Frontend guidelines
|
||||
@@ -53,10 +58,10 @@ the rest conversationally.
|
||||
| `.trellis/spec/frontend/quality-guidelines.md` | Linting, testing, accessibility |
|
||||
|
||||
|
||||
### Thinking guides (already populated)
|
||||
### Thinking guides
|
||||
|
||||
`.trellis/spec/guides/` contains general thinking guides pre-filled with
|
||||
best practices. Customize only if something clearly doesn't fit this project.
|
||||
`.trellis/spec/guides/` contains this project's code-reuse and cross-layer
|
||||
contract checks, backed by the actual API/query/UI flow.
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user