doc: add how to set up instructions #2585
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -78,7 +78,39 @@ More details about [AI Reviewer here →](../repositories-configure/integrations | |||||
| 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. | ||||||
|
|
||||||
| #### 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. | ||||||
|
There was a problem hiding this comment. The phrase "to the AI Reviewer" is redundant in this sentence. Consider rephrasing to: "To improve the results of the AI Reviewer, you can provide custom instructions. These instructions are specific to..."
Suggested change
|
||||||
|
|
||||||
| These instructions are specified in a `review.md` file in the `.codacy/instructions` directory of your repository. | ||||||
|
|
||||||
| 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: | ||||||
|
Contributor
There was a problem hiding this comment. ⚪ LOW RISK Suggestion: Minor grammatical improvement.
Suggested change
|
||||||
|
|
||||||
| ```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. | ||||||
| ``` | ||||||
|
|
||||||
|
|
||||||
|
There was a problem hiding this comment. 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. |
||||||
|
|
||||||
| **Notes** | ||||||
|
|
||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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: