Skip to content

Conversation

@aaronpowell
Copy link
Contributor

No description provided.

Copilot AI review requested due to automatic review settings July 2, 2025 10:39
@github-actions
Copy link
Contributor

github-actions bot commented Jul 2, 2025

⚠️ README.md needs to be updated

The update-readme.js script detected changes that need to be made to the README.md file.

Please run node update-readme.js locally and commit the changes before merging this PR.

View diff
diff --git a/README.md b/README.md
index 3b7ac47..d36058c 100644
--- a/README.md
+++ b/README.md
@@ -64,6 +64,9 @@ Ready-to-use prompt templates for specific development scenarios and tasks, defi
### FinOps
- [Azure Cost Optimize](prompts/az-cost-optimize.prompt.md) - Analyze Azure resources used in the app (IaC files and/or resources in a target rg) and optimize costs - creating GitHub issues for identified optimizations.

+### Uncategorised
+- [C# Documentation Best Practices](prompts/csharp-docs.prompt.md) - Ensure that C# types are documented with XML comments and follow best practices for documentation.
+


> 💡 **Usage**: Use `/prompt-name` in VS Code chat, run `Chat: Run Prompt` command, or hit the run button while you have a prompt open.

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

Adds a new prompt file defining XML documentation best practices for C# members.

  • Introduces prompts/csharp-docs.prompt.md outlining use of <summary>, <param>, <returns>, and other XML tags.
  • Provides nested guidance for <inheritdoc/> behavior.

- Use `<param>` for method parameters.
- Use `<returns>` for method return values.
- Use `<remarks>` for additional information, which can include implementation details, usage notes, or any other relevant context.
- Use `<example>` for usage examples on how to use the the member.
Copy link

Copilot AI Jul 2, 2025

Choose a reason for hiding this comment

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

Remove the duplicate word 'the' so it reads 'usage examples on how to use the member.'

Suggested change
- Use `<example>` for usage examples on how to use the the member.
- Use `<example>` for usage examples on how to use the member.

Copilot uses AI. Check for mistakes.
@aaronpowell aaronpowell merged commit e9e9646 into main Jul 2, 2025
3 checks passed
@aaronpowell aaronpowell deleted the csharp-docs branch July 2, 2025 10:41
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