Skip to content

doc: add how to set up instructions #2585

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alerizzo wants to merge 2 commits into
base: master
Choose a base branch
from
+35 −0
Open

doc: add how to set up instructions #2585

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
92af496
doc: add how to set up instructions
alerizzo Feb 18, 2026
8ac5b48
specify language in snippet
alerizzo Feb 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions docs/codacy-ai/codacy-ai.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,38 @@ More details about [AI Reviewer here →](../repositories-configure/integrations
4. Save your changes. Once enabled, Codacy will start adding a Summary to your pull requests based on the AI-enriched reviews.
5. To request a PR Review from codacy, add a **`codacy-review`** label to your Pull Request. Codacy listens to the event and will publish the review as soon as it's ready.
Copy link

Copilot AI Feb 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The word "codacy" should be capitalized to "Codacy" for consistency with the same instruction in the github-integration.md file (line 47), which says "To request a PR Review from Codacy".

Suggested change
5. To request a PR Review from codacy, add a **`codacy-review`** label to your Pull Request. Codacy listens to the event and will publish the review as soon as it's ready.
5. To request a PR Review from Codacy, add a **`codacy-review`** label to your Pull Request. Codacy listens to the event and will publish the review as soon as it's ready.

Copilot uses AI. Check for mistakes.

#### Custom Instructions

To improve the results of the AI Reviewer, you can provide custom instructions to the AI Reviewer. These instructions are specific to a repository and help the AI Reviewer understand the structure of the code, the business logic of the project, and your own preferences.

These instructions are specified in a `review.md` file in the `.codacy/instructions` directory of your repository.

You can kickstart this instructions file asking your AI coding agent of choice to summarize the project and the codebase. Here is an example prompt:
Copy link

Copilot AI Feb 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing the word "by" before "asking". The sentence should read: "You can kickstart this instructions file by asking your AI coding agent of choice to summarize the project and the codebase."

Suggested change
You can kickstart this instructions file asking your AI coding agent of choice to summarize the project and the codebase. Here is an example prompt:
You can kickstart this instructions file by asking your AI coding agent of choice to summarize the project and the codebase. Here is an example prompt:

Copilot uses AI. Check for mistakes.

```markdown
Analyze this repository and generate a concise AI PR reviewer instruction file in Markdown.

The file should give a PR reviewer the essential context that won't be visible in a diff. Cover:

- **Purpose**: What this repo does in 1-2 sentences.
- **Architecture**: High-level structure, patterns used (e.g. MVC, event-driven, monorepo, etc.).
- **Folder structure**: Key directories and what lives in each. Skip obvious ones.
- **Stack**: Languages, frameworks, major libraries, and their roles.
- **Testing**: Framework used, where tests live, what's expected to be tested.
- **Code style & conventions**: Naming, file organization, formatting tools, any patterns enforced.
- **PR-specific rules**: Branch strategy, what a PR should/shouldn't include, migration rules, etc.
- **Common pitfalls**: Things reviewers should flag — anti-patterns, known gotchas, areas that break easily.
- **Out of scope**: Anything reviewers should explicitly ignore or not enforce.

Rules for the output:
- Output only the Markdown content, no preamble or explanation.
- Be concise. Every line should earn its place — no filler.
- Use short sections with bullet points. Avoid long prose.
- If something is not applicable or not inferable, omit the section entirely.
```



**Notes**

- Codacy does not use your code, repository contents, or comments to train external AI models. No customer code or review text is incorporated into model training.
Expand Down
3 changes: 3 additions & 0 deletions docs/repositories-configure/integrations/github-integration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@ The AI Reviewer combines the reliability of deterministic, rule-based static cod

It provides feedback on missing or weak tests, complex or duplicated code, and keeps security concerns up to date. Beyond that, it adds contextual insights about whether the changes follow the requirements, business rules, and logic used in the project.

!!! tip
Improve the AI Reviewer results by providing custom instructions to the AI Reviewer. [Learn how to do it here →](../../codacy-ai/codacy-ai.md#custom-instructions).

This setting can be enabled at a repository or organization level. Once enabled, Codacy will start adding a Summary to your pull requests based on the AI-enriched reviews. To request a PR Review from Codacy, add a **`codacy-review`** label to your Pull Request. Codacy listens to the event and will publish the review as soon as it's ready.


Expand Down
Loading