chore(templates): align issue templates with conventional commit format (#427)

WilliamBerryiii · web-flow · commit 2d287021ebb6 · 2026-02-05T11:42:05.000-08:00
## Description Converted all 6 issue template title prefixes from bracket-style (e.g., `[Bug]:`) to Conventional Commit format (e.g., `fix:`). Cleaned up scope definitions in commit-message.instructions.md from 26 inherited scopes to 12 project-relevant ones. Updated documentation examples in agent and prompt files to match the new format and added contributing guidance for issue title conventions. - chore(templates): convert 6 issue template title prefixes to conventional commit style - `bug-report.yml`: `[Bug]:` → `fix:` - `custom-agent-request.yml`: `[Custom Agent]:` → `feat(agents):` - `general-issue.yml`: `[Issue]:` → `feat:` - `instruction-file-request.yml`: `[Instruction File]:` → `feat(instructions):` - `prompt-request.yml`: `[Prompt]:` → `feat(prompts):` - `skill-request.yml`: `[Skill]:` → `feat(skills):` - refactor(instructions): reduce commit-message.instructions.md scopes from 26 to 12 project-relevant definitions - Added descriptions for each scope - Removed irrelevant scopes inherited from microsoft/edge-ai (cloud, iot-ops, terraform, bicep, etc.) - Updated attribution from microsoft/edge-ai to microsoft/hve-core - docs(agents): update github-issue-manager.agent.md examples to use conventional commit format - docs(prompts): update github-add-issue.prompt.md examples to use conventional commit format - docs: add "GitHub Issue Title Conventions" section to ai-artifacts-common.md with issue type mapping table ## Related Issue(s) Closes #426 ## Type of Change Select all that apply: **Code & Documentation:** - [ ] Bug fix (non-breaking change fixing an issue) - [ ] New feature (non-breaking change adding functionality) - [ ] Breaking change (fix or feature causing existing functionality to change) - [x] Documentation update **Infrastructure & Configuration:** - [ ] GitHub Actions workflow - [ ] Linting configuration (markdown, PowerShell, etc.) - [ ] Security configuration - [ ] DevContainer configuration - [ ] Dependency update **AI Artifacts:** - [ ] Reviewed contribution with `prompt-builder` agent and addressed all feedback - [x] Copilot instructions (`.github/instructions/*.instructions.md`) - [x] Copilot prompt (`.github/prompts/*.prompt.md`) - [x] Copilot agent (`.github/agents/*.agent.md`) - [ ] Copilot skill (`.github/skills/*/SKILL.md`) **Other:** - [ ] Script/automation (`.ps1`, `.sh`, `.py`) - [ ] Other (please describe): ## Sample Prompts (for AI Artifact Contributions) Not applicable - this PR updates existing artifacts to align with new conventions rather than adding new functionality. ## Testing - Verified all 6 issue templates have correct Conventional Commit title prefixes - Validated YAML syntax with `npm run lint:yaml` - Validated markdown files with `npm run lint:md` - Validated frontmatter with `npm run lint:frontmatter` ## Checklist ### Required Checks - [x] Documentation is updated (if applicable) - [x] Files follow existing naming conventions - [x] Changes are backwards compatible (if applicable) - [ ] Tests added for new functionality (if applicable) ### AI Artifact Contributions - [ ] Used `/prompt-analyze` to review contribution - [ ] Addressed all feedback from `prompt-builder` review - [x] Verified contribution follows common standards and type-specific requirements ### Required Automated Checks The following validation commands must pass before merging: - [x] Markdown linting: `npm run lint:md` - [ ] Spell checking: `npm run spell-check` - [x] Frontmatter validation: `npm run lint:frontmatter` - [ ] Link validation: `npm run lint:md-links` - [ ] PowerShell analysis: `npm run lint:ps` ## Security Considerations - [x] This PR does not contain any sensitive or NDA information - [ ] Any new dependencies have been reviewed for security issues - [x] Security-related scripts follow the principle of least privilege ## Additional Notes The scope cleanup removed 17 irrelevant scopes inherited from microsoft/edge-ai that do not apply to hve-core (cloud, data, edge, application, tools, resource-group, security-identity, observability, fabric, messaging, vm-host, cncf-cluster, iot-ops, blueprints, terraform, bicep, azureml). Five new scopes were added to cover hve-core artifact categories (agents, skills, templates, workflows, extension). 📝 - Generated by Copilot
diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -1,6 +1,6 @@
 name: Bug Report
 description: Report a bug or unexpected behavior
-title: "[Bug]: "
+title: "fix: "
 labels: ["bug", "needs-triage"]
 body:
   - type: markdown
diff --git a/.github/ISSUE_TEMPLATE/custom-agent-request.yml b/.github/ISSUE_TEMPLATE/custom-agent-request.yml
@@ -1,6 +1,6 @@
 name: Custom Agent Request
 description: Request a new custom agent or slash command
-title: "[Custom Agent]: "
+title: "feat(agents): "
 labels: ["custom-agent", "needs-triage"]
 body:
   - type: markdown
diff --git a/.github/ISSUE_TEMPLATE/general-issue.yml b/.github/ISSUE_TEMPLATE/general-issue.yml
@@ -1,6 +1,6 @@
 name: General Issue
 description: Report a general issue or request a feature
-title: "[Issue]: "
+title: "feat: "
 labels: ["needs-triage"]
 body:
   - type: markdown
diff --git a/.github/ISSUE_TEMPLATE/instruction-file-request.yml b/.github/ISSUE_TEMPLATE/instruction-file-request.yml
@@ -1,6 +1,6 @@
 name: Copilot Instruction File Request
 description: Request a new GitHub Copilot instruction file
-title: "[Instruction File]: "
+title: "feat(instructions): "
 labels: ["instruction-file", "needs-triage"]
 body:
   - type: markdown
diff --git a/.github/ISSUE_TEMPLATE/prompt-request.yml b/.github/ISSUE_TEMPLATE/prompt-request.yml
@@ -1,6 +1,6 @@
 name: Prompt Template Request
 description: Request a new prompt template
-title: "[Prompt]: "
+title: "feat(prompts): "
 labels: ["prompt", "needs-triage"]
 body:
   - type: markdown
diff --git a/.github/ISSUE_TEMPLATE/skill-request.yml b/.github/ISSUE_TEMPLATE/skill-request.yml
@@ -1,6 +1,6 @@
 name: Skill Request
 description: Request a new skill package
-title: "[Skill]: "
+title: "feat(skills): "
 labels: ["skill", "needs-triage"]
 body:
   - type: markdown
diff --git a/.github/agents/github-issue-manager.agent.md b/.github/agents/github-issue-manager.agent.md
@@ -95,8 +95,8 @@ Navigation session example:
 
 ## Results ({count} issues)
 
-* #42: [Bug]: Login button broken
-* #41: [Bug]: Search not working
+* #42: fix: login button broken
+* #41: fix: search not working
 
 ## Actions Taken
 
diff --git a/.github/instructions/commit-message.instructions.md b/.github/instructions/commit-message.instructions.md
@@ -1,5 +1,5 @@
 ---
-description: 'Required instructions for creating all commit messages - Brought to you by microsoft/edge-ai'
+description: 'Required instructions for creating all commit messages - Brought to you by microsoft/hve-core'
 maturity: stable
 ---
 
@@ -31,30 +31,18 @@ Types MUST be one of the following:
 
 Scopes MUST be one of the following:
 
-- `(prompts)`
-- `(instructions)`
-- `(settings)`
-- `(cloud)`
-- `(data)`
-- `(docs)`
-- `(edge)`
-- `(application)`
-- `(tools)`
-- `(resource-group)`
-- `(security-identity)`
-- `(observability)`
-- `(fabric)`
-- `(messaging)`
-- `(vm-host)`
-- `(cncf-cluster)`
-- `(iot-ops)`
-- `(blueprints)`
-- `(terraform)`
-- `(bicep)`
-- `(scripts)`
-- `(adrs)`
-- `(build)`
-- `(azureml)`
+- `(agents)` - Custom agent definitions in `.github/agents/`
+- `(prompts)` - Prompt templates in `.github/prompts/`
+- `(instructions)` - Coding guidelines in `.github/instructions/`
+- `(skills)` - Skill packages in `.github/skills/`
+- `(templates)` - Issue and PR templates in `.github/ISSUE_TEMPLATE/`
+- `(workflows)` - GitHub Actions in `.github/workflows/`
+- `(extension)` - VS Code extension in `extension/`
+- `(scripts)` - Automation scripts in `scripts/`
+- `(docs)` - Documentation in `docs/`
+- `(adrs)` - Architecture Decision Records
+- `(settings)` - Configuration files (`.vscode/`, linter configs)
+- `(build)` - Build system and dependencies
 
 ## Description
 
diff --git a/.github/prompts/github-add-issue.prompt.md b/.github/prompts/github-add-issue.prompt.md
@@ -66,7 +66,7 @@ You WILL discover and parse available issue templates from `.github/ISSUE_TEMPLA
 ```yaml
 name: Bug Report
 description: File a bug report
-title: "[Bug]: "
+title: "fix: "
 labels: ["bug", "triage"]
 assignees:
   - octocat
@@ -199,7 +199,7 @@ You WILL create the GitHub issue using MCP tools.
 {
   "tool": "mcp_github_create_issue",
   "parameters": {
-    "title": "[Bug]: Login button doesn't work on mobile devices",
+    "title": "fix: login button doesn't work on mobile devices",
     "body": "**What happened?**\nThe login button doesn't work on mobile devices\n\n**Contact Details**\njohn@example.com",
     "labels": ["bug", "triage"],
     "assignees": ["octocat"]
@@ -214,7 +214,7 @@ You WILL create the GitHub issue using MCP tools.
   "number": 42,
   "html_url": "https://github.com/owner/repo/issues/42",
   "state": "open",
-  "title": "[Bug]: Login button doesn't work on mobile devices"
+  "title": "fix: login button doesn't work on mobile devices"
 }
 ```
 
@@ -253,7 +253,7 @@ You WILL log issue creation to artifact file for tracking and reference.
 
 ### Title
 
-[Bug]: Login button doesn't work on mobile devices
+fix: login button doesn't work on mobile devices
 
 ### Body
 
diff --git a/docs/contributing/ai-artifacts-common.md b/docs/contributing/ai-artifacts-common.md
@@ -483,6 +483,33 @@ Brought to you by microsoft/hve-core
 * Exact text: "Brought to you by microsoft/hve-core"
 * Or team-specific: "Brought to you by microsoft/edge-ai"
 
+## GitHub Issue Title Conventions
+
+When filing issues against hve-core, use Conventional Commit-style title prefixes that match the repository's commit message format.
+
+### Issue Title Format
+
+| Issue Type           | Title Prefix          | Example                                         |
+|----------------------|-----------------------|-------------------------------------------------|
+| Bug reports          | `fix:`                | `fix: validation script fails on Windows paths` |
+| Agent requests       | `feat(agents):`       | `feat(agents): add Azure cost analysis agent`   |
+| Prompt requests      | `feat(prompts):`      | `feat(prompts): add PR description generator`   |
+| Instruction requests | `feat(instructions):` | `feat(instructions): add Go language standards` |
+| Skill requests       | `feat(skills):`       | `feat(skills): add diagram generation skill`    |
+| General features     | `feat:`               | `feat: support multi-root workspaces`           |
+| Documentation        | `docs:`               | `docs: clarify installation steps`              |
+
+### Benefits
+
+* Issue titles align with commit and PR title conventions
+* Automated changelog generation works correctly
+* Scopes clearly identify affected artifact categories
+* Consistent formatting across all project tracking
+
+### Reference
+
+See [commit-message.instructions.md](../../.github/instructions/commit-message.instructions.md) for the complete list of types and scopes.
+
 ## Getting Help
 
 When contributing AI artifacts:
