Instruction file imported from agreaves-ms/hve-ado-scaffold (.github/instructions/commit-message.instructions.md). Copyright stays with the author.

Commit Message Guidelines

Name: commit-message
Author: agreaves-ms

This document provides instructions for generating standardized commit messages.

Format Requirements

Use Conventional Commit Messages
All changes MUST be in present tense

Types

Types MUST be one of the following:

feat - A new feature
fix - A bug fix
refactor - A code change that neither fixes a bug nor adds a feature
perf - A code change that improves performance
style - Changes that do not affect the meaning of the code
test - Adding missing tests or correcting existing tests
docs - Documentation only changes
build - Changes that affect the build system or external dependencies
ops - Changes to operational components
chore - Other changes that don't modify src or test files

Scopes

Scopes MUST be one of the following:

(prompts)
(instructions)
(settings)
(cloud)
(edge)
(application)
(tools)
(resource-group)
(security-identity)
(observability)
(data)
(fabric)
(messaging)
(vm-host)
(cncf-cluster)
(iot-ops)
(observability)
(messaging)
(blueprints)
(terraform)
(bicep)
(scripts)
(adrs)
(build)
(azureml)

Description

Description MUST be short and LESS THAN 100 bytes
Examples:

feat: update logic with new feature
chore: cleaned up and moved code from A to B
feat(iot-ops): add parameters to take name instead of id

Body (Optional)

For larger changes only:

Body starts with a blank line
Contains a summarized bulleted list (0-5 items AT MOST)
MUST be LESS THAN 300 bytes

Footer

Footer MUST start with a blank line
Must include an emoji that represents the change
Must end with - Generated by Copilot

Example Complete Commit Message - Large

feat(cloud): add new authentication flow

- add commit message, markdown, C# along with C# test instructions
- introduce task planner and researcher, prompt builder, and adr creation chatmodes
- configure markdownlint and VS Code workspace settings
- add ADO work items prompts for getting and preparing my work items
- add .gitignore and cleanup README newlines

🔒 - Generated by Copilot

Example Complete Commit Message - Medium to Small

feat(prompts): update summarize-my-work-items.prompt.md to clarify json output, correct get-my-work-items.prompt.md to fallback to wit_my_work_items

🔒 - Generated by Copilot

{ "ocm": "1", "id": "agreaves-ms-hve-ado-scaffold-commit-message-instructions", "kind": "skill", "name": "commit-message", "description": "Guidelines for generating conventional commit messages - Brought to you by microsoft/edge-ai", "publisher": "agreaves-ms", "version": "1.0.0", "capabilities": { "domains": [ "general" ], "tags": [ "skill-md", "github-instructions" ], "languages": [ "en" ] }, "quality_prior": 0.6, "examples": [ "Guidelines for generating conventional commit messages - Brought to you by microsoft/edge-ai" ], "primary": false, "metadata": { "source": { "provider": "github-instructions", "repository": "https://github.com/agreaves-ms/hve-ado-scaffold", "path": ".github/instructions/commit-message.instructions.md", "ref": "ffb47f78c1112e69b6287e04829da881ca33e679", "url": "https://github.com/agreaves-ms/hve-ado-scaffold/blob/ffb47f78c1112e69b6287e04829da881ca33e679/.github/instructions/commit-message.instructions.md", "key": "agreaves-ms/hve-ado-scaffold/.github/instructions/commit-message.instructions.md" } }, "instructions": "# Commit Message Guidelines\n\nThis document provides instructions for generating standardized commit messages.\n\n## Format Requirements\n\n- Use Conventional Commit Messages\n- All changes MUST be in present tense\n\n## Types\n\nTypes MUST be one of the following:\n\n- `feat` - A new feature\n- `fix` - A bug fix\n- `refactor` - A code change that neither fixes a bug nor adds a feature\n- `perf` - A code change that improves performance\n- `style` - Changes that do not affect the meaning of the code\n- `test` - Adding missing tests or correcting existing tests\n- `docs` - Documentation only changes\n- `build` - ", "cost": { "context_tokens": 608 } }

commit-message

About

Commit Message Guidelines

Format Requirements

Types

Scopes

Description

Body (Optional)

Footer

Example Complete Commit Message - Large

Example Complete Commit Message - Medium to Small

Use it

Manifest

Reviews