Skip to content

{Misc.} Refine GH issue template#32894

Merged
necusjz merged 1 commit intoAzure:devfrom
necusjz:refine-issue-tmpl
Mar 4, 2026
Merged

{Misc.} Refine GH issue template#32894
necusjz merged 1 commit intoAzure:devfrom
necusjz:refine-issue-tmpl

Conversation

@necusjz
Copy link
Member

@necusjz necusjz commented Mar 4, 2026

Related command

Description

Our issue template is somewhat confusing. Often, people cannot find the correct entry point for feature requests, which results in missing information in the requests:
image

Testing Guide

History Notes

[Component Name 1] BREAKING CHANGE: az command a: Make some customer-facing breaking change
[Component Name 2] az command b: Add some customer-facing feature


This checklist is used to make sure that common guidelines for a pull request are followed.

@necusjz necusjz requested a review from DanielMicrosoft March 4, 2026 03:18
@necusjz necusjz self-assigned this Mar 4, 2026
Copilot AI review requested due to automatic review settings March 4, 2026 03:18
@azure-client-tools-bot-prd
Copy link

azure-client-tools-bot-prd bot commented Mar 4, 2026

️✔️AzureCLI-FullTest
️✔️acr
️✔️latest
️✔️3.12
️✔️3.13
️✔️acs
️✔️latest
️✔️3.12
️✔️3.13
️✔️advisor
️✔️latest
️✔️3.12
️✔️3.13
️✔️ams
️✔️latest
️✔️3.12
️✔️3.13
️✔️apim
️✔️latest
️✔️3.12
️✔️3.13
️✔️appconfig
️✔️latest
️✔️3.12
️✔️3.13
️✔️appservice
️✔️latest
️✔️3.12
️✔️3.13
️✔️aro
️✔️latest
️✔️3.12
️✔️3.13
️✔️backup
️✔️latest
️✔️3.12
️✔️3.13
️✔️batch
️✔️latest
️✔️3.12
️✔️3.13
️✔️batchai
️✔️latest
️✔️3.12
️✔️3.13
️✔️billing
️✔️latest
️✔️3.12
️✔️3.13
️✔️botservice
️✔️latest
️✔️3.12
️✔️3.13
️✔️cdn
️✔️latest
️✔️3.12
️✔️3.13
️✔️cloud
️✔️latest
️✔️3.12
️✔️3.13
️✔️cognitiveservices
️✔️latest
️✔️3.12
️✔️3.13
️✔️compute_recommender
️✔️latest
️✔️3.12
️✔️3.13
️✔️computefleet
️✔️latest
️✔️3.12
️✔️3.13
️✔️config
️✔️latest
️✔️3.12
️✔️3.13
️✔️configure
️✔️latest
️✔️3.12
️✔️3.13
️✔️consumption
️✔️latest
️✔️3.12
️✔️3.13
️✔️container
️✔️latest
️✔️3.12
️✔️3.13
️✔️containerapp
️✔️latest
️✔️3.12
️✔️3.13
️✔️core
️✔️latest
️✔️3.12
️✔️3.13
️✔️cosmosdb
️✔️latest
️✔️3.12
️✔️3.13
️✔️databoxedge
️✔️latest
️✔️3.12
️✔️3.13
️✔️dls
️✔️latest
️✔️3.12
️✔️3.13
️✔️dms
️✔️latest
️✔️3.12
️✔️3.13
️✔️eventgrid
️✔️latest
️✔️3.12
️✔️3.13
️✔️eventhubs
️✔️latest
️✔️3.12
️✔️3.13
️✔️feedback
️✔️latest
️✔️3.12
️✔️3.13
️✔️find
️✔️latest
️✔️3.12
️✔️3.13
️✔️hdinsight
️✔️latest
️✔️3.12
️✔️3.13
️✔️identity
️✔️latest
️✔️3.12
️✔️3.13
️✔️iot
️✔️latest
️✔️3.12
️✔️3.13
️✔️keyvault
️✔️latest
️✔️3.12
️✔️3.13
️✔️lab
️✔️latest
️✔️3.12
️✔️3.13
️✔️managedservices
️✔️latest
️✔️3.12
️✔️3.13
️✔️maps
️✔️latest
️✔️3.12
️✔️3.13
️✔️marketplaceordering
️✔️latest
️✔️3.12
️✔️3.13
️✔️monitor
️✔️latest
️✔️3.12
️✔️3.13
️✔️mysql
️✔️latest
️✔️3.12
️✔️3.13
️✔️netappfiles
️✔️latest
️✔️3.12
️✔️3.13
️✔️network
️✔️latest
️✔️3.12
️✔️3.13
️✔️policyinsights
️✔️latest
️✔️3.12
️✔️3.13
️✔️postgresql
️✔️latest
️✔️3.12
️✔️3.13
️✔️privatedns
️✔️latest
️✔️3.12
️✔️3.13
️✔️profile
️✔️latest
️✔️3.12
️✔️3.13
️✔️rdbms
️✔️latest
️✔️3.12
️✔️3.13
️✔️redis
️✔️latest
️✔️3.12
️✔️3.13
️✔️relay
️✔️latest
️✔️3.12
️✔️3.13
️✔️resource
️✔️latest
️✔️3.12
️✔️3.13
️✔️role
️✔️latest
️✔️3.12
️✔️3.13
️✔️search
️✔️latest
️✔️3.12
️✔️3.13
️✔️security
️✔️latest
️✔️3.12
️✔️3.13
️✔️servicebus
️✔️latest
️✔️3.12
️✔️3.13
️✔️serviceconnector
️✔️latest
️✔️3.12
️✔️3.13
️✔️servicefabric
️✔️latest
️✔️3.12
️✔️3.13
️✔️signalr
️✔️latest
️✔️3.12
️✔️3.13
️✔️sql
️✔️latest
️✔️3.12
️✔️3.13
️✔️sqlvm
️✔️latest
️✔️3.12
️✔️3.13
️✔️storage
️✔️latest
️✔️3.12
️✔️3.13
️✔️synapse
️✔️latest
️✔️3.12
️✔️3.13
️✔️telemetry
️✔️latest
️✔️3.12
️✔️3.13
️✔️util
️✔️latest
️✔️3.12
️✔️3.13
️✔️vm
️✔️latest
️✔️3.12
️✔️3.13

@azure-client-tools-bot-prd
Copy link

azure-client-tools-bot-prd bot commented Mar 4, 2026

️✔️AzureCLI-BreakingChangeTest
️✔️Non Breaking Changes

@yonzhan
Copy link
Collaborator

yonzhan commented Mar 4, 2026

Thank you for your contribution! We will review the pull request and get back to you soon.

@github-actions
Copy link

github-actions bot commented Mar 4, 2026

The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR.

Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions).
After that please run the following commands to enable git hooks:

pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>

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 refines GitHub issue templates to improve clarity and help users find the correct entry point when submitting issues. The PR was motivated by confusion where users couldn't identify the right template for feature requests, resulting in missing information.

Changes:

  • Renamed issue template titles to be cleaner/more consistent (adding emojis to Bug Report and Feature Request, removing emoji from others, renaming community feature request to "Community Idea")
  • Added trailing periods to template description fields for consistency
  • Minor wording fix: "for microsoft internal" → "from Microsoft internal" in 02_feature_request.yml

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file
File Description
.github/ISSUE_TEMPLATE/01_bug_report.yml Added 🐞 emoji to template name and trailing period to description
.github/ISSUE_TEMPLATE/02_feature_request.yml Renamed from "[Microsoft Internal / Service Team] Feature Request" to "✨ Feature Request"; minor description wording fix
.github/ISSUE_TEMPLATE/03_community_idea.md Renamed from "🚀Feature request" to "Community Idea"; trailing period added to description
.github/ISSUE_TEMPLATE/04_documentation_issue.yml Simplified name (removed emoji) and added trailing period
.github/ISSUE_TEMPLATE/05_what-if_feedback.yml Simplified name (removed "Azure CLI" prefix) and added trailing period
Comments suppressed due to low confidence (2)

.github/ISSUE_TEMPLATE/02_feature_request.yml:2

  • The template name was changed from "[Microsoft Internal / Service Team] Feature Request" to "✨ Feature Request", which removes the critical signal that this template is intended only for Microsoft internal or service team users. Community users seeing two feature-related templates ("✨ Feature Request" and "Community Idea") may be confused about which to use, and may incorrectly pick the internal template. The description on line 2 still says "from Microsoft internal or service team", but the title is the first and most visible indicator. Consider keeping some indication of the internal/service team audience in the name (e.g., "✨ Feature Request (Microsoft Internal / Service Team)") to prevent misuse.
    .github/ISSUE_TEMPLATE/03_community_idea.md:3
  • Renaming 03_community_idea.md from "🚀Feature request" to "Community Idea" removes the word "feature request" from the community template. When community users look for how to submit a feature request, they will now see "✨ Feature Request" and "Community Idea" — and will likely pick "✨ Feature Request" because it matches their intent, even though that template is intended for Microsoft internal/service teams and asks for fields like PM Contact, Engineer Contact, and Resource Provider. This could actually worsen the problem described in the PR. Consider a name for the community template that retains "feature request" language (e.g., "💡 Community Feature Request") so it clearly signals the right entry point for community users.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@necusjz necusjz merged commit 5ae35f4 into Azure:dev Mar 4, 2026
54 checks passed
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.

3 participants