|
| 1 | +--- |
| 2 | +name: CodeBridger Development Skill |
| 3 | +description: Core development guidelines and documentation for the Subturtle/CodeBridger ecosystem. Triggered when working on dashboard-app or server. |
| 4 | +--- |
| 5 | + |
| 6 | +# Development Guidelines |
| 7 | + |
| 8 | +## General Principles |
| 9 | + |
| 10 | +- **Modularity**: Prioritize modularity in all code changes. Organize logic into distinct modules (Server-side) or reusable components (Frontend). |
| 11 | +- **ClickUp Integration**: |
| 12 | + - Task management primarily relies on ClickUp. |
| 13 | + - Always reference the ClickUp task ID in commit messages. Format: `feat: #taskid message`. |
| 14 | +- **Communication**: |
| 15 | + - Favor answering questions and providing explanations over direct code modifications unless explicitly requested. |
| 16 | + - Ensure all explanations are clear and provide necessary context. |
| 17 | + |
| 18 | +## Framework Documentation |
| 19 | + |
| 20 | +Always refer to the official documentation for package-specific implementations: |
| 21 | + |
| 22 | +### Server-Side (@modular-rest/server) |
| 23 | +- **Primary Docs**: [modular-rest_server.md](./modular-rest_server.md) |
| 24 | +- **Key Patterns**: |
| 25 | + - Use `defineCollection` in `db.ts` for database models. |
| 26 | + - Use `defineFunction` in `functions.ts` for API logic. |
| 27 | + - Avoid manual router creation unless necessary (`router.ts`). |
| 28 | + |
| 29 | +### Frontend-Side (@modular-rest/client) |
| 30 | +- **Primary Docs**: [modular-rest_client.md](./modular-rest_client.md) |
| 31 | +- **Key Patterns**: |
| 32 | + - Reference the JS client for consuming services and calling server functions. |
| 33 | + |
| 34 | +### UI Components (lib-vue-components) |
| 35 | +- **Primary Docs**: [lib-vue-components.md](./lib-vue-components.md) |
| 36 | +- **Key Patterns**: |
| 37 | + - Import components directly from `@codebridger/lib-vue-components` as needed (e.g., `import { Button } from '@codebridger/lib-vue-components'`). |
| 38 | + - Follow the design system guidelines for consistent aesthetics. |
| 39 | + |
| 40 | + |
| 41 | +--- |
| 42 | + |
| 43 | +You must read the specific documentation files listed above before proposing or implementing any technical changes related to these packages. |
0 commit comments