-
Notifications
You must be signed in to change notification settings - Fork 45
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.
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
Changes from all commits
92af496
8ac5b48
02fea5a
a06ee91
2683195
f5b717b
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -14,7 +14,7 @@ _This feature leverages OpenAI models, and is strictly opt-in: it will only run | |||||
|
|
||||||
| AI-enhanced comments are optional, machine-generated suggestions that appear directly in pull requests and review threads. They use Codacy's AI to provide concise issue summaries, remediation suggestions, and links to relevant documentation — helping reviewers and authors quickly understand and fix problems. | ||||||
|
|
||||||
| More details about [AI-enhanced comments here →](../repositories-configure/integrations/github-integration.md#ai-enhanced-comments). | ||||||
| More details about [AI-enhanced comments here](../repositories-configure/integrations/github-integration.md#ai-enhanced-comments). | ||||||
|
|
||||||
| **How to turn it on** | ||||||
|
|
||||||
|
|
@@ -47,7 +47,7 @@ _This feature leverages OpenAI models, and is strictly opt-in: you need to get i | |||||
|
|
||||||
| Codacy False Positive triage analyzes results on a commit basis to give you visibility into issues that may be false positives (based on their context). During triage, each issue is given a confidence score along with an explanation. When the confidence level falls below a defined threshold, the issue is then flagged as an AI false positive and surfaced for manual review. You can evaluate potential false positives during a pull request in app or on any Codacy page where issues appear. These issues can be ignored or marked as Not a false positive. | ||||||
|
|
||||||
| More details about [False Positives here →](../repositories/commits.md#false-positive-issues). | ||||||
| More details about [False Positives here](../repositories/commits.md#false-positive-issues). | ||||||
|
|
||||||
| **How to turn it on** | ||||||
|
|
||||||
|
|
@@ -70,15 +70,47 @@ _This feature leverages Google Gemini models, and is strictly opt-in: it will on | |||||
|
|
||||||
| The AI Reviewer combines the reliability of deterministic, rule-based static code analysis with the power of AI. It draws in the necessary context from source code and PR metadata to ensure the business intent matches the technical outcome, and can catch logic gaps that conventional scanners (and human reviewers) often miss. | ||||||
|
|
||||||
| More details about [AI Reviewer here →](../repositories-configure/integrations/github-integration.md#ai-reviewer). | ||||||
| More details about [AI Reviewer here](../repositories-configure/integrations/github-integration.md#ai-reviewer). | ||||||
|
|
||||||
| **How to turn it on** | ||||||
|
|
||||||
| 1. Go to your organization or repository settings in Codacy. | ||||||
| 2. Navigate to the "Integrations" or "AI features" section (depending on your Codacy plan and UI version). | ||||||
| 3. Find "AI Reviewer", under "Status checks", and toggle the feature to "On" for the repository or organization scope you want to enable. | ||||||
| 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. | ||||||
| 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. | ||||||
|
|
||||||
| #### 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. | ||||||
|
||||||
| 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. | |
| To improve the results of the AI Reviewer, you can provide custom instructions. 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
⚪ LOW RISK
Suggestion: Minor grammatical improvement.
| 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: | |
| You can kickstart this file by asking your AI coding agent of choice to summarize the project and the codebase. Here is an example prompt: |
Copilot
AI
Feb 19, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Extra blank line. For consistency with the rest of the document (see lines 26-27 and 55-56), there should be only one blank line between the code block and the Notes section.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
⚪ LOW RISK
Suggestion: This sentence is repetitive. This might be a simple fix: