-
Notifications
You must be signed in to change notification settings - Fork 497
Improve the auditing documentation by making it more prescriptive #3504
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve the auditing documentation by making it more prescriptive #3504
Conversation
|
Learn Build status updates of commit 65590c7: ✅ Validation status: passed
For more details, please refer to the build report. |
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.
Pull Request Overview
This PR reorganizes the Auditing Packages documentation to improve logical flow and readability. The changes focus on restructuring content without altering the core information provided.
- Moves the "Excluding advisories" section to follow the "Warning codes" section for better contextual placement
- Relocates the "Running NuGet Audit in CI" section toward the end of the document
- Updates a table entry to reference NuGet 7.0 and Visual Studio 2026
- Adds a new subsection explaining when to exclude advisories
- Consolidates MCP server information into the existing list of remediation options
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
|
Learn Build status updates of commit 438f87c: ✅ Validation status: passed
For more details, please refer to the build report. |
|
Learn Build status updates of commit 6330b5a: ✅ Validation status: passed
For more details, please refer to the build report. |
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
jebriede
left a comment
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.
LGTM!
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
|
Learn Build status updates of commit 6a5e8af: ✅ Validation status: passed
For more details, please refer to the build report. |
This is being done as per our discussion during the preparedness meeting.
Makes things more assertive for the exclusion of advisories.
I think there are more improvements that can be done here, but those might be more significant and harder to follow.
Summary of the changes I've done: