Conversation
Codacy's Analysis Summary0 new issue (≤ 0 minor issue) Review Pull Request in Codacy →
|
|
Overall readability score: 54.2 (🟢 +0.01)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
There was a problem hiding this comment.
Pull request overview
This pull request adds documentation about custom instructions for the AI Reviewer feature. The changes provide users with guidance on how to improve AI Reviewer results by creating a review.md file with repository-specific instructions.
Changes:
- Added a tip callout in the GitHub integration documentation pointing users to the custom instructions feature
- Added a new "Custom Instructions" section in the Codacy AI documentation explaining how to set up and use custom instructions for the AI Reviewer
- Included an example prompt that users can provide to AI coding agents to generate appropriate instruction files
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/repositories-configure/integrations/github-integration.md | Added a tip box with a cross-reference link to the custom instructions documentation |
| docs/codacy-ai/codacy-ai.md | Added comprehensive "Custom Instructions" section with setup instructions and an example prompt for generating instruction files |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -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. | |||
There was a problem hiding this comment.
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".
| 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. |
|
|
||
| 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: |
There was a problem hiding this comment.
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."
| 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: |
👀 Live preview
🚧 To do