Skip to content

Conversation

@BillWagner
Copy link
Member

@BillWagner BillWagner commented Aug 14, 2025

Comments aren't localized, so prefer text in markdown.


Internal previews

📄 File 🔗 Preview link
.github/copilot-instructions.md .github/copilot-instructions

Comments aren't localized, so prefer text in markdown.
@BillWagner BillWagner requested a review from a team as a code owner August 14, 2025 13:38
@dotnetrepoman dotnetrepoman bot added this to the August 2025 milestone Aug 14, 2025
@BillWagner BillWagner requested review from Copilot and gewarren August 14, 2025 13:38
@learn-build-service-prod
Copy link
Contributor

PoliCheck Scan Report

The following reports lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 issues. Other issues are also a high priority. 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 comment that you post to the PR. The feedback helps reduce false positive instances in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

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 PR updates the GitHub Copilot instructions to clarify the preferred approach for code documentation. The change emphasizes that detailed explanations should be placed in markdown text rather than in code comments, since comments aren't localized.

  • Adds guidance on balancing comments and markdown text for code documentation

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@learn-build-service-prod
Copy link
Contributor

PoliCheck Scan Report

The following reports lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 issues. Other issues are also a high priority. 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 comment that you post to the PR. The feedback helps reduce false positive instances in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

Copy link
Contributor

@gewarren gewarren left a comment

Choose a reason for hiding this comment

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

I left a suggestion for consideration, up to you.

Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
@BillWagner BillWagner enabled auto-merge (squash) August 14, 2025 15:20
@learn-build-service-prod
Copy link
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 issues. Other issues are also a high priority. 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 found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@BillWagner BillWagner merged commit 93504fc into dotnet:main Aug 14, 2025
8 checks passed
@BillWagner BillWagner deleted the markdown-over-comments branch August 14, 2025 19:46
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