Skip to content

Commit 93504fc

Browse files
BillWagnerCopilotgewarren
authored
Prefer text over comments (#47966)
* Prefer text over comments Comments aren't localized, so prefer text in markdown. * Update .github/copilot-instructions.md Co-authored-by: Copilot <[email protected]> * Update .github/copilot-instructions.md Co-authored-by: Genevieve Warren <[email protected]> --------- Co-authored-by: Copilot <[email protected]> Co-authored-by: Genevieve Warren <[email protected]>
1 parent 27b93b5 commit 93504fc

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

.github/copilot-instructions.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,4 +42,6 @@ If you're assigned a GitHub issue that's labeled "breaking-change", include the
4242

4343
If you include a code snippet that's more than 6 lines long, put it in a separate .cs file in a folder named "snippets" in the same folder as the document. Within the "snippets" folder, add a new directory with the name of the document. For example, if the document is named "my-doc.md", create a folder named "snippets/my-doc" folder. Also add a simple .csproj file to the same directory that targets the latest version of .NET. It can be a library or executable project.
4444

45+
When you add code, use code comments sparingly because they don't get localized. You can use them to briefly clarify code-specific details (such as logic, parameters, or edge cases). Put any critical information and context in the markdown text.
46+
4547
If you're adding a new Markdown file, it should be named in all lowercase with hyphens separating words. Also, omit any filler words such as "the" or "a" from the file name.

0 commit comments

Comments
 (0)