docs: mention secret redacting CF-2343#2625
Conversation
Up to standards ✅🟢 Issues
|
There was a problem hiding this comment.
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.
|
Overall readability score: 54.08 (🟢 +0)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
There was a problem hiding this comment.
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
👀 Live preview
🚧 To do