Skip to content

docs: mention secret redacting CF-2343#2625

Open
manufacturist wants to merge 2 commits intomasterfrom
feat/cf-2343
Open

docs: mention secret redacting CF-2343#2625
manufacturist wants to merge 2 commits intomasterfrom
feat/cf-2343

Conversation

@manufacturist
Copy link
Copy Markdown
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

@manufacturist manufacturist requested a review from a team as a code owner March 31, 2026 14:09
Copilot AI review requested due to automatic review settings March 31, 2026 14:09
@codacy-production
Copy link
Copy Markdown
Contributor

codacy-production bot commented Mar 31, 2026

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

AI Reviewer: first review requested successfully. AI can make mistakes. Always validate suggestions.

Run reviewer

TIP This summary will be updated as you push new changes. Give us feedback

Copy link
Copy Markdown
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

Updates Codacy AI documentation to explicitly state that secrets are automatically redacted from code context before being sent to the AI model.

Changes:

  • Add a new privacy note describing automatic secret redaction (API keys, tokens, credentials, and other high-entropy strings).
  • Normalize the “Prompts are neither stored nor visible by anyone.” bullet punctuation in both relevant sections.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 31, 2026

Overall readability score: 54.08 (🟢 +0)

File Readability
codacy-ai.md 55.66 (🔴 -0.56)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
codacy-ai.md 55.66 37.2 10.82 12.3 12.35 7.26
  🔴 -0.56 🔴 -0.51 🔴 -0.07 🔴 -0.3 🔴 -0.06 🟢 +0.05

Averages:

  Readability FRE GF ARI CLI DCRS
Average 54.08 42.98 10.95 12.33 12.24 8.02
  🟢 +0 🟢 +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
Copy Markdown
Contributor

@codacy-production codacy-production bot 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 documentation update correctly implements the required disclosures regarding secret redaction for both 'Smart False Positive Triage' and 'AI Reviewer' features. Codacy results are up to standards, and the intent-agent has verified that the necessary disclaimer sections were added.

The main areas for improvement focus on maintaining consistency across the documentation. The privacy and security guarantees are currently duplicated in multiple sections, which has already led to a minor inconsistency where the top-level privacy section lacks the latest details. Centralizing these points is recommended for long-term maintenance.

Test suggestions

  • Verify that the 'Smart False Positive Triage' notes section contains the secret redaction disclaimer.
  • Verify that the 'AI Reviewer' notes section contains the secret redaction disclaimer.

🗒️ Improve review quality by adding custom instructions

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.

2 participants