Revise pull request template for clarity and structure (#703)

* Revise pull request template for clarity and structure

Updated the pull request template to enhance clarity and organization of the pre-merge checklist.

* Clarify live test instructions for Azure team members

Updated instructions for running live tests for Azure team members.
This commit is contained in:
Josh Free authored and GitHub committed 2025-07-23 15:36:17 -07:00
1 parent 30b1d0e10e
commit bd3b5ca331
2 files changed
+20 -14

No files matched your search

+19 -13
View File
@@ -1,18 +1,24 @@
## What does this PR do?
`[Provide a clear, concise description of the changes]`
`[Any additional context, screenshots, or information that helps reviewers]`
## GitHub issue number?
`[Link to the GitHub issue this PR addresses]`
## Pre-merge checklist
- [ ] **I have read the [contribution guidelines](https://github.com/Azure/azure-mcp/blob/main/CONTRIBUTING.md) covering pull request process, code style, and testing**
- [ ] PR title is clear and informative
- [ ] Commit history is clean with informative messages (no previously merged commits appear in PR history). [See cleanup guide](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/cleaning-up-commits.md)
- [ ] Added comprehensive tests for core features
- [ ] Added `CHANGELOG.md` entry for user-impacting changes (bug fixes, new features, UI/UX changes)
- [ ] Spelling check passes with `.\eng\common\spelling\Invoke-Cspell.ps1`
## Pre-merge Checklist
- [ ] Required for All PRs
- [ ] **Read [contribution guidelines](https://github.com/Azure/azure-mcp/blob/main/CONTRIBUTING.md)**
- [ ] PR title clearly describes the change
- [ ] Commit history is clean with descriptive messages ([cleanup guide](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/cleaning-up-commits.md))
- [ ] Added comprehensive tests for new/modified functionality
- [ ] Updated `CHANGELOG.md` for product changes (`features, bug fixes, UI/UX, updated dependencies`)
- [ ] Spelling check passes: `.\eng\common\spelling\Invoke-Cspell.ps1`
- [ ] For MCP tool changes, updated:
- [ ] Documentation in `README.md`
- [ ] Command list in `/docs/azmcp-commands.md`
- [ ] End-to-end test prompts in `/e2eTests/e2eTestPrompts.md`
- [ ] **Team member live testing:**
- [ ] **Security review:** Review PR for security vulnerabilities and malicious code before running tests (e.g., cryptocurrency mining, email spam, data exfiltration, or other harmful activities)
- [ ] **Test execution:** Add comment `/azp run azure - mcp` to trigger pipeline
- [ ] Updated `README.md` documentation
- [ ] Updated command list in `/docs/azmcp-commands.md`
- [ ] Updated test prompts in `/e2eTests/e2eTestPrompts.md`
- [ ] 👉 For Community (non-Azure team member) PRs:
- [ ] **Security review**: Reviewed code for security vulnerabilities, malicious code, or suspicious activities before running tests (`crypto mining, spam, data exfiltration, etc.`)
- [ ] **Manual tests run**: added comment `/azp run azure - mcp` to run *Live Test Pipeline*
+1 -1
View File
@@ -269,7 +269,7 @@ To build a local image for testing purposes:
### Live Tests
> ⚠️ If you are a Microsoft employee with Azure source permissions then please review our [Azure Internal Onboarding Documentation](https://aka.ms/azmcp/intake). Team members can run live tests by adding this comment to the PR `/azp run azure - mcp` to start the run.
> ⚠️ If you are a Microsoft employee with Azure source permissions then please review our [Azure Internal Onboarding Documentation](https://aka.ms/azmcp/intake). As part of reviewing community contributions, Azure team members can run live tests by adding this comment to the PR `/azp run azure - mcp`.
Before running live tests:
- [Install Azure PowerShell](https://learn.microsoft.com/powershell/azure/install-azure-powershell)