These instructions help CodeAnt understand your coding standards, framework preferences, and project-specific requirements.

Accessing Dashboard Instructions

Navigate to your Dashboard settings:

  1. Go to app.codeant.ai/settings/customized-review
  2. Select Instructions from the dropdown menu
  3. Click Add New to create a new instruction

Creating Instructions

Step 1: Select Repositories

Choose which repositories should apply this instruction:

  • Use the search bar to find specific repositories
  • Select multiple repositories using checkboxes
  • All selected repositories will receive the same instruction

Step 2: Configure Instruction

Instruction Description (Required)

  • Provide a clear, specific description of what this instruction does
  • Be explicit about the expected behavior or exceptions

File Patterns (Required)

  • Specify which files this instruction applies to using glob patterns
  • Click Add to include multiple patterns
  • Use minimatch syntax for pattern matching

Sample Instructions

Framework and Version Specifications

React 18 with TypeScript:

Description: "We are using React 18.2.0 with TypeScript 5.0. Allow concurrent features like Suspense, automatic batching, and new hooks. Do not flag React 18 specific APIs as errors."

File Patterns: 
- **/*.tsx
- **/*.ts
- src/components/**/*.js

Vue 3 Composition API:

Description: "Project uses Vue 3.3+ with Composition API and script setup syntax. Allow ref(), reactive(), and computed() without imports when using script setup."

File Patterns:
- **/*.vue
- src/**/*.ts

Next.js 14 App Router:

Description: "Using Next.js 14 with App Router. Allow server components, async components, and new metadata API. Do not flag app directory structure as errors."

File Patterns:
- app/**/*.tsx
- app/**/*.ts
- **/*.server.tsx

Language and Localization Preferences

Spanish Code Suggestions:

Description: "Provide code suggestions, and comments in Spanish. Generate error messages and documentation in Spanish when possible."

File Patterns:
- **/*.js
- **/*.ts
- **/*.jsx
- **/*.tsx

Pattern Examples

Common File Patterns

PatternDescription
**/*.{js,ts,jsx,tsx}All JavaScript/TypeScript files
src/components/**/*.tsxReact components only
**/*.test.*All test files
!**/node_modules/**Exclude dependencies
*.config.{js,ts}Configuration files
docs/**/*.mdDocumentation files
src/{utils,helpers}/**/*Utility functions
**/*.d.tsTypeScript declaration files

Advanced Patterns

PatternDescription
src/**/!(*.test).tsTypeScript files excluding tests
**/*.{story,stories}.{js,tsx}Storybook files
{src,lib}/**/*.{gql,graphql}GraphQL files
**/migrations/**/*.sqlDatabase migrations
src/**/*.{module,service}.tsNestJS modules and services

Once saved, instructions will be applied to all selected repositories during the next code review cycle.