Skip to content

doc: add how to set up instructions#2585

Open
alerizzo wants to merge 2 commits intomasterfrom
doc-ai-instructions
Open

doc: add how to set up instructions#2585
alerizzo wants to merge 2 commits intomasterfrom
doc-ai-instructions

Conversation

@alerizzo
Copy link
Contributor

👀 Live preview

🚧 To do

  • If relevant, include the Jira issue key at the end of the pull request title
  • Perform a self-review of the changes
  • Fix any issues reported by the CI/CD

Copilot AI review requested due to automatic review settings February 18, 2026 15:08
@alerizzo alerizzo requested a review from a team as a code owner February 18, 2026 15:08
@codacy-production
Copy link
Contributor

codacy-production bot commented Feb 18, 2026

Codacy's Analysis Summary

0 new issue (≤ 0 minor issue)
0 new security issue

Review Pull Request in Codacy →

AI Reviewer available: add the codacy-review label to get contextual insights without leaving GitHub.

@github-actions
Copy link
Contributor

github-actions bot commented Feb 18, 2026

Overall readability score: 54.2 (🟢 +0.01)

File Readability
github-integration.md 52.31 (🟢 +0.64)
codacy-ai.md 56.48 (🟢 +0.67)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
github-integration.md 52.31 35.98 11.33 12.7 12.53 7.71
  🟢 +0.64 🔴 -0.1 🟢 +0.04 🟢 +0.1 🟢 +0.18 🟢 +0.06
codacy-ai.md 56.48 37.4 10.75 11.9 12.18 7.31
  🟢 +0.67 🟢 +0 🟢 +0.06 🟢 +0.2 🟢 +0.06 🟢 +0.06

Averages:

  Readability FRE GF ARI CLI DCRS
Average 54.2 43.06 10.93 12.32 12.22 8.01
  🟢 +0.01 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.
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.

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Comments