Skip to main content
Generate PR descriptions using your team’s template. CodeAnt keeps your original description.

​
Set it up

1

Add your template

Commit pull_request_template.md at the repository root on the default branch. Use this example or your existing template:
pull_request_template.md
CodeAnt reads the default branch, even if the PR targets another branch.
2

Enable PR descriptions

Open review configuration 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.
3

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.

​
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?

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.
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 with the PR URL if it still fails.
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.