| 1 | --- |
| 2 | name: "project-conventions" |
| 3 | description: "Core conventions and patterns for this codebase" |
| 4 | domain: "project-conventions" |
| 5 | confidence: "medium" |
| 6 | source: "template" |
| 7 | --- |
| 8 | |
| 9 | ## Context |
| 10 | |
| 11 | > **This is a starter template.** Replace the placeholder patterns below with your actual project conventions. Skills train agents on codebase-specific practices — accurate documentation here improves agent output quality. |
| 12 | |
| 13 | ## Patterns |
| 14 | |
| 15 | ### [Pattern Name] |
| 16 | |
| 17 | Describe a key convention or practice used in this codebase. Be specific about what to do and why. |
| 18 | |
| 19 | ### Error Handling |
| 20 | |
| 21 | <!-- Example: How does your project handle errors? --> |
| 22 | <!-- - Use try/catch with specific error types? --> |
| 23 | <!-- - Log to a specific service? --> |
| 24 | <!-- - Return error objects vs throwing? --> |
| 25 | |
| 26 | ### Testing |
| 27 | |
| 28 | <!-- Example: What test framework? Where do tests live? How to run them? --> |
| 29 | <!-- - Test framework: Jest/Vitest/node:test/etc. --> |
| 30 | <!-- - Test location: test/, __tests__/, *.test.ts, etc. --> |
| 31 | <!-- - Run command: npm test, etc. --> |
| 32 | |
| 33 | ### Code Style |
| 34 | |
| 35 | <!-- Example: Linting, formatting, naming conventions --> |
| 36 | <!-- - Linter: ESLint config? --> |
| 37 | <!-- - Formatter: Prettier? --> |
| 38 | <!-- - Naming: camelCase, snake_case, etc.? --> |
| 39 | |
| 40 | ### File Structure |
| 41 | |
| 42 | <!-- Example: How is the project organized? --> |
| 43 | <!-- - src/ — Source code --> |
| 44 | <!-- - test/ — Tests --> |
| 45 | <!-- - docs/ — Documentation --> |
| 46 | |
| 47 | ## Examples |
| 48 | |
| 49 | ``` |
| 50 | // Add code examples that demonstrate your conventions |
| 51 | ``` |
| 52 | |
| 53 | ## Anti-Patterns |
| 54 | |
| 55 | <!-- List things to avoid in this codebase --> |
| 56 | - **[Anti-pattern]** — Explanation of what not to do and why. |