Skip to content

Expand C# documentation best practices#273

Merged
aaronpowell merged 3 commits into
github:mainfrom
gewarren:patch-1
Oct 1, 2025
Merged

Expand C# documentation best practices#273
aaronpowell merged 3 commits into
github:mainfrom
gewarren:patch-1

Conversation

@gewarren
Copy link
Copy Markdown
Contributor

Pull Request Checklist

  • I have read and followed the CONTRIBUTING.md guidelines.
  • My contribution adds a new instruction, prompt, or chat mode file in the correct directory.
  • The file follows the required naming convention.
  • The content is clearly structured and follows the example format.
  • I have tested my instructions, prompt, or chat mode with GitHub Copilot.
  • I have run node update-readme.js and verified that README.md is up to date.

Description

Updated the documentation guidelines based on https://github.com/dotnet/dotnet-api-docs/wiki.


Type of Contribution

  • New instruction file.
  • New prompt file.
  • New chat mode file.
  • Other (please specify): Updated prompt file

By submitting this pull request, I confirm that my contribution abides by the Code of Conduct and will be licensed under the MIT License.

Copilot AI review requested due to automatic review settings September 30, 2025 22:18
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

This PR expands the C# documentation best practices by reorganizing and adding comprehensive guidelines from the official .NET documentation standards. The update transforms a basic list of XML comment tags into a structured guide with specific sections for different API types.

Key changes:

  • Reorganized content into logical sections (Methods, Constructors, Properties, Exceptions)
  • Added detailed guidance for parameter descriptions, return values, and property documentation
  • Expanded exception documentation guidelines with specific formatting requirements

Comment thread prompts/csharp-docs.prompt.md Outdated
Comment thread prompts/csharp-docs.prompt.md Outdated
gewarren and others added 2 commits September 30, 2025 15:21
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@aaronpowell aaronpowell merged commit febd4c4 into github:main Oct 1, 2025
2 checks passed
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.

3 participants