microsoft / microsoft/CSS-Exchange
[Work Item] Code formatting check to enforce consistent function description
Open
@dpaulson45 is already working on this.
Since Dec 6, 2024.
Build Process
Need Investigation
Work Item
- Dominant language
- PowerShell
- Stars
- 1.3k
- Forks
- 395
- Avg merge
- 14h 7m
- Merged PRs (30d)
- 5
Description
Describe the work
We recently discussed whether it would be good to enforce a consistent function description in this repository. We all agreed that we should investigate whether we can make it possible by enforcing this by the help of a code formatting check.
Requirements are:
- Format this by following the comment help standard (https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_comment_based_help?view=powershell-7.4)
- Place the description above the function/method to align with the C# standard to ensure consistency
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.