microsoft/hve-core
Publicmirrored fromhttps://github.com/microsoft/hve-coreAvailable
plugins/coding-standards/README.md
62lines · modecode
| 1 | <!-- markdownlint-disable-file --> |
| 2 | # Coding Standards |
| 3 | |
| 4 | Language-specific coding instructions and pre-PR code review agents for bash, Bicep, C#, PowerShell, Python, Rust, and Terraform projects |
| 5 | |
| 6 | ## Overview |
| 7 | |
| 8 | Enforce language-specific coding conventions and best practices across your projects, with pre-PR code review agents for catching functional defects early. This collection provides instructions for bash, Bicep, C#, PowerShell, Python, Rust, and Terraform that are automatically applied based on file patterns, plus agents that review branch diffs before opening pull requests. |
| 9 | |
| 10 | This collection includes: |
| 11 | |
| 12 | - **Functional Code Review** — Pre-PR branch diff reviewer for functional correctness, error handling, edge cases, and testing gaps |
| 13 | |
| 14 | Instructions for: |
| 15 | |
| 16 | - **Bash** — Shell scripting conventions and best practices |
| 17 | - **Bicep** — Infrastructure as code implementation standards |
| 18 | - **C#** — Code and test conventions including nullable reference types, async patterns, and xUnit testing |
| 19 | - **PowerShell** — Script and module conventions including comment-based help, CmdletBinding, PSScriptAnalyzer compliance, and copyright headers |
| 20 | - **Python** — Scripting implementation with type hints, docstrings, and uv project management |
| 21 | - **Rust** — Rust development conventions targeting the 2021 edition |
| 22 | - **Terraform** — Infrastructure as code with provider configuration and module structure |
| 23 | |
| 24 | ## Install |
| 25 | |
| 26 | ```bash |
| 27 | copilot plugin install coding-standards@hve-core |
| 28 | ``` |
| 29 | |
| 30 | ## Agents |
| 31 | |
| 32 | | Agent | Description | |
| 33 | |------------------------|---------------------------------------------------------------------------------------------------------------------------------------------| |
| 34 | | functional-code-review | Pre-PR branch diff reviewer for functional correctness, error handling, edge cases, and testing gaps - Brought to you by microsoft/hve-core | |
| 35 | |
| 36 | ## Commands |
| 37 | |
| 38 | | Command | Description | |
| 39 | |------------------------|-------------------------------------------------------------------------------------------------------------------------------------------| |
| 40 | | functional-code-review | Pre-PR branch diff review for functional correctness, error handling, edge cases, and testing gaps - Brought to you by microsoft/hve-core | |
| 41 | |
| 42 | ## Instructions |
| 43 | |
| 44 | | Instruction | Description | |
| 45 | |-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |
| 46 | | bash | Instructions for bash script implementation - Brought to you by microsoft/hve-core | |
| 47 | | bicep | Instructions for Bicep infrastructure as code implementation - Brought to you by microsoft/hve-core | |
| 48 | | csharp | Required instructions for C# (CSharp) research, planning, implementation, editing, or creating - Brought to you by microsoft/hve-core | |
| 49 | | csharp-tests | Required instructions for C# (CSharp) test code research, planning, implementation, editing, or creating - Brought to you by microsoft/hve-core | |
| 50 | | pester | Instructions for Pester testing conventions - Brought to you by microsoft/hve-core | |
| 51 | | powershell | Instructions for PowerShell scripting implementation - Brought to you by microsoft/hve-core | |
| 52 | | rust | Required instructions for Rust research, planning, implementation, editing, or creating - Brought to you by microsoft/hve-core | |
| 53 | | rust-tests | Required instructions for Rust test code research, planning, implementation, editing, or creating - Brought to you by microsoft/hve-core | |
| 54 | | python-script | Instructions for Python scripting implementation - Brought to you by microsoft/hve-core | |
| 55 | | terraform | Instructions for Terraform infrastructure as code implementation - Brought to you by microsoft/hve-core | |
| 56 | | uv-projects | Create and manage Python virtual environments using uv commands | |
| 57 | | hve-core-location | Important: hve-core is the repository containing this instruction file; Guidance: if a referenced prompt, instructions, agent, or script is missing in the current directory, fall back to this hve-core location by walking up this file's directory tree. | |
| 58 | |
| 59 | --- |
| 60 | |
| 61 | > Source: [microsoft/hve-core](https://github.com/microsoft/hve-core) |
| 62 | |
| 63 | |