> ## Documentation Index
> Fetch the complete documentation index at: https://docs.qodo.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Repository context files

> Learn how to enhance AI agent performance by adding custom context files to your repository

<Warning>
  **Git Integration (formerly Qodo Merge)** – AI code review agents for pull requests. This documentation describes the Qodo v1 experience. For the Qodo v2 documentation, click [here.](/code-review)
</Warning>

Modern AI coding assistants work best when they understand the specific context of your project. By adding custom context files to your repository, you can provide the AI agent with essential information about your codebase, development practices, and project-specific requirements.

<Note>
  Context files help the agent generate more accurate, relevant, and high-quality suggestions tailored to your team's needs.
</Note>

## Supported context file formats

The AI agent automatically recognizes and processes several standard context file formats when they're placed in the root directory of your main branch:

| File Name   | Purpose                                                                                                                                      |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| `agents.md` | General-purpose context file for AI coding assistants ([learn more about the agents.md standard](https://agents.md/?utm_source=chatgpt.com)) |
| `qodo.md`   | Context specific to Qodo-based AI tools                                                                                                      |
| `claude.md` | Context optimized for Claude AI integration                                                                                                  |

<Warning>
  **Warning:**

  Context files must be placed in the **root directory** of your **main branch** to be detected by the AI agent.
</Warning>

## What to include in context files

Context files can contain various types of information to guide the AI agent:

### Architecture and design patterns

* Overview of your system architecture
* Design patterns and principles your team follows
* Key technical decisions and their rationale

### Coding standards

* Language-specific style guidelines
* Naming conventions for variables, functions, and classes
* Code organization preferences

### Development workflow

* Testing requirements and strategies
* Code review expectations
* Deployment considerations

### Project-specific information

* Domain knowledge and business logic
* Common patterns used across the codebase
* Dependencies and their purposes
* Known limitations or technical debt

## Best practices

<Tabs>
  <Tab title="Keep It Concise">
    Focus on key information impacting code suggestions. Avoid redundant details.
  </Tab>

  <Tab title="Update Regularly">
    Regularly review and update context files for current information.
  </Tab>

  <Tab title="Use Clear Language">
    Write clear, direct instructions for specific, actionable guidance.
  </Tab>

  <Tab title="Prioritize Impact">
    Prioritize context that significantly affects code quality and productivity.
  </Tab>
</Tabs>

## Get started

### Enable context files

Before adding context files, you need to enable this feature in your Qodo configuration file:

```bash theme={null}
[config]
add_repo_metadata = true
```

### Configure custom context file names

You can also specify custom file names for your context files using the configuration:

```js theme={null}
[config]
add_repo_metadata_file_list = ["file1.md", "file2.md", ...]
```

This allows you to use your own naming convention or include multiple context files tailored for different purposes.

<Note>
  **Info:** Learn more about the Qodo Merge configuration file in the [configuration Documentation](/v1/configuration/configuration-file).
</Note>

### Add a context file to your repository

Follow these steps to add a context file to your repository:

<Steps>
  <Step>
    Enable `add_repo_metadata` in your Qodo Merge configuration file
  </Step>

  <Step>
    Create one of the supported context files (`agents.md`, `qodo.md`, or `claude.md`) in your repository's root directory
  </Step>

  <Step>
    Add relevant context about your project, starting with your most important guidelines
  </Step>

  <Step>
    Commit the file to your main branch
  </Step>

  <Step>
    The AI agent will automatically detect and use this context in future interactions
  </Step>
</Steps>

<Tip>
  By investing time in creating comprehensive context files, you'll see immediate improvements in the quality and relevance of AI-generated code suggestions.
</Tip>