Code review Instructions
Configure review instructions for CodeAnt AI
CodeAnt AI allows you to provide custom instructions to tailor the code review process for your specific project needs. These instructions help CodeAnt understand your coding standards, ignore false positives, and focus on what matters most for your codebase.
Setup
1. Create Configuration Folder
Create a .codeant
folder in your repository root (same level as your .git
folder):
2. Create Instructions File
Inside the .codeant
folder, create an instructions.json
file with your custom review instructions.
Configuration Format
The instructions.json
file uses the following structure:
File Pattern Examples
CodeAnt uses minimatch for glob patterns. Here are common patterns:
Pattern | Description |
---|---|
**/*.js | All JavaScript files in any directory |
src/**/*.ts | All TypeScript files in src directory and subdirectories |
*.test.js | Test files in root directory only |
**/*.{js,ts,jsx,tsx} | All JavaScript/TypeScript files |
!**/node_modules/** | Exclude node_modules directory |
components/**/*.vue | All Vue files in components directory |
**/*.spec.{js,ts} | All spec test files |
Instruction Examples
Common Use Cases
1. Ignore Specific Patterns:
2. Framework-Specific Rules:
3. API Integration Guidelines:
4. Security Focus:
Sample instructions.json
Here’s a complete example configuration:
Best Practices
- Use descriptive IDs: Make instruction IDs clear and meaningful
- Be specific with patterns: Target exact files or directories that need special treatment
- Document reasoning: Use clear descriptions explaining why each instruction exists
- Test patterns: Verify your glob patterns match the intended files
- Keep it minimal: Only add instructions when necessary to avoid over-customization
Once you’ve created your instructions.json
file, CodeAnt will automatically apply these custom instructions during the next code review.