mirror of
https://github.com/lobehub/lobe-chat.git
synced 2026-06-14 03:30:19 +00:00
📝 docs: add agent code style guidance (#15434)
* 📝 docs: add code style guidance for hook extraction and file splitting * 📝 docs: tighten file-splitting guidance * 📝 docs: clarify agent guidance wording
This commit is contained in:
@@ -53,6 +53,10 @@ For Modal specifically, see the dedicated **modal** skill — use the imperative
|
|||||||
| Layout | Center, DraggablePanel, Flexbox, Grid, Header, MaskShadow |
|
| Layout | Center, DraggablePanel, Flexbox, Grid, Header, MaskShadow |
|
||||||
| Navigation | Burger, Menu, SideNav, Tabs |
|
| Navigation | Burger, Menu, SideNav, Tabs |
|
||||||
|
|
||||||
|
## State
|
||||||
|
|
||||||
|
When a feature component manages more than 3 pieces of state (`useState`/`useReducer`/derived state), extract the logic into a custom hook (e.g. `useXxx`). Keep the component focused on rendering — the hook holds state and handlers, so logic can be unit-tested without rendering the component.
|
||||||
|
|
||||||
## Layout
|
## Layout
|
||||||
|
|
||||||
Use `Flexbox` and `Center` from `@lobehub/ui`. See `references/layout-kit.md` for full props and examples.
|
Use `Flexbox` and `Center` from `@lobehub/ui`. See `references/layout-kit.md` for full props and examples.
|
||||||
|
|||||||
@@ -124,6 +124,10 @@ cd packages/database && bunx vitest run --silent='passed-only' '[file]'
|
|||||||
- For dev preview: translate `locales/zh-CN/` and `locales/en-US/`
|
- For dev preview: translate `locales/zh-CN/` and `locales/en-US/`
|
||||||
- `pnpm i18n` is slow; run it manually when locale keys need updating (e.g. before opening a PR).
|
- `pnpm i18n` is slow; run it manually when locale keys need updating (e.g. before opening a PR).
|
||||||
|
|
||||||
|
### Code Style
|
||||||
|
|
||||||
|
- When a single file grows beyond \~800 lines, consider splitting it into multiple files (extract sub-components, hooks, helpers, or types). Smaller, focused files are friendly to humans and agents.
|
||||||
|
|
||||||
### Code Review
|
### Code Review
|
||||||
|
|
||||||
Before reviewing a PR / diff / branch change, read the **review-checklist** skill (`.agents/skills/review-checklist/SKILL.md`) — it lists the recurring mistakes specific to this codebase.
|
Before reviewing a PR / diff / branch change, read the **review-checklist** skill (`.agents/skills/review-checklist/SKILL.md`) — it lists the recurring mistakes specific to this codebase.
|
||||||
|
|||||||
Reference in New Issue
Block a user