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

# Repository PR Templates

> Use your repository’s Markdown template for generated PR descriptions.

Generate PR descriptions using your team's template. CodeAnt keeps your original description.

## Set it up

<Steps>
  <Step title="Add your template">
    Commit `pull_request_template.md` at the repository root on the **default branch**. Use this example or your existing template:

    ```markdown pull_request_template.md theme={"theme":"css-variables"}
    ## Summary
    <Describe the change.>

    ## Testing
    <Include test results provided by the author.>

    ## Checklist
    - [ ] Tests have passed
    ```

    CodeAnt reads the default branch, even if the PR targets another branch.
  </Step>

  <Step title="Enable PR descriptions">
    [Open review configuration](https://app.codeant.ai/x/settings/prconfsettings) and select your repository.

    Under **PR Annotations → PR Description**, choose:

    * **Update Description** to publish in the PR body.
    * **As a Comment** to publish in a comment.
  </Step>

  <Step title="Turn on repository templates">
    Set **Use repository PR template** to **On**.

    Set **PR template path** to your file's location:

    * `pull_request_template.md` for the example above.
    * `.github/PULL_REQUEST_TEMPLATE.md` for an existing GitHub template.

    Use the exact repository-relative path. Settings save automatically.
  </Step>
</Steps>

## Check it works

Open a new PR. After CodeAnt reviews it, check that **CodeAnt-AI Description** follows your template and **User description** retains what you wrote.

Include ticket links and test results in your PR description to help fill the template. Unknown fields should stay unchanged; review the generated content before merging.

## Need help?

<AccordionGroup>
  <Accordion title="CodeAnt uses the standard format">
    Confirm template usage is **On** and the path points to a non-empty file on the **default branch**. Files in `.github/` need an explicit path. CodeAnt falls back to its standard format if it cannot read the template.
  </Accordion>

  <Accordion title="No description appears">
    Enable **Process PR Review** and set **PR Description** to **Update Description** or **As a Comment**. Check review exclusions and, for draft PRs, **Draft PR Analysis**. [Contact support](mailto:support@codeant.ai) with the PR URL if it still fails.
  </Accordion>

  <Accordion title="Apply this to all repositories">
    Select your organization in review configuration, then enable templates and set the path. Each repository needs its own template at that path. At repository scope, choose **Inherited from Org** and reset any path override to follow those defaults.
  </Accordion>
</AccordionGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.