mirror of
https://github.com/bendtherules/opencode-multi-model.git
synced 2026-08-18 13:42:21 +00:00
docs(AGENTS): rename JSDoc Comments heading to Documentation and add note to update README when implementation changes
This commit is contained in:
@@ -81,11 +81,12 @@ bun run typecheck && bun run lint
|
|||||||
- Group imports: external packages, internal modules, types
|
- Group imports: external packages, internal modules, types
|
||||||
- Biome automatically organizes imports
|
- Biome automatically organizes imports
|
||||||
|
|
||||||
### JSDoc Comments
|
### Documentation
|
||||||
|
|
||||||
- Use JSDoc for all exported functions
|
- Use JSDoc for all exported functions
|
||||||
- Include `@example`, `@param`, and `@returns` descriptions
|
- Include `@example`, `@param`, and `@returns` descriptions
|
||||||
- Add inline comments for hard-to-understand code
|
- Add inline comments for hard-to-understand code
|
||||||
|
- Modify Readme.md, if implementation details have changed.
|
||||||
|
|
||||||
### Error Handling
|
### Error Handling
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user