Skip to content

Conversation

@audreyttt
Copy link
Member

Updated agent configuration for compute PowerShell pull requests, detailing objectives, rules, and required artifacts.

Description

Mandatory Checklist

  • SHOULD update ChangeLog.md file(s) appropriately
    • Update src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.
      • A snippet outlining the change(s) made in the PR should be written under the ## Upcoming Release header in the past tense.
    • Should not change ChangeLog.md if no new release is required, such as fixing test case only.
  • SHOULD regenerate markdown help files if there is cmdlet API change. Instruction
  • SHOULD have proper test coverage for changes in pull request.
  • SHOULD NOT adjust version of module manually in pull request

Updated agent configuration for compute PowerShell pull requests, detailing objectives, rules, and required artifacts.
@azure-client-tools-bot-prd
Copy link

Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status.

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

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
Copy link

Copilot AI Nov 21, 2025

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.

Suggested change
- 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
```

Copilot uses AI. Check for mistakes.
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