-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Add instructions for Compute PR agent #28914
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Updated agent configuration for compute PowerShell pull requests, detailing objectives, rules, and required artifacts.
| Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status. |
There was a problem hiding this 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 introduces a new agent configuration file that provides detailed instructions for creating PowerShell pull requests in the Azure Compute module. The agent serves as a guide for implementing new features in PowerShell cmdlets, covering everything from parameter authoring to test creation.
Key Changes:
- Adds comprehensive instructions for modifying Compute PowerShell cmdlets
- Establishes rules for parameter authoring, execution flow, and file structure
- Defines required artifacts including code changes, documentation, tests, and changelog updates
| - If code is split, also update related files (e.g., `NewAzureVMCommand.cs`, `VirtualMachineStrategy.cs`). | ||
| 4) **Help Content** | ||
| - `src/Compute/Compute/help/<command>.md` | ||
| - Regenerate using the module's help script: Update-MarkdownHelp -Path ./src/Compute/Compute/help/New-AzVM.md -AlphabeticParamsOrder -UseFullTypeName |
Copilot
AI
Nov 21, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] The help regeneration command should be formatted as a code block for clarity and to prevent line wrapping issues. Consider wrapping the command in backticks or a code fence.
| - Regenerate using the module's help script: Update-MarkdownHelp -Path ./src/Compute/Compute/help/New-AzVM.md -AlphabeticParamsOrder -UseFullTypeName | |
| - Regenerate using the module's help script: | |
| ``` | |
| Update-MarkdownHelp -Path ./src/Compute/Compute/help/New-AzVM.md -AlphabeticParamsOrder -UseFullTypeName | |
| ``` |
Updated agent configuration for compute PowerShell pull requests, detailing objectives, rules, and required artifacts.
Description
Mandatory Checklist
Please choose the target release of Azure PowerShell. (⚠️ Target release is a different concept from API readiness. Please click below links for details.)
Check this box to confirm: I have read the Submitting Changes section of
CONTRIBUTING.mdand reviewed the following information:ChangeLog.mdfile(s) appropriatelysrc/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.## Upcoming Releaseheader in the past tense.ChangeLog.mdif no new release is required, such as fixing test case only.