microsoft/hve-core
Publicmirrored fromhttps://github.com/microsoft/hve-coreAvailable
.github/instructions/commit-message.instructions.md
103lines · modecode
| 1 | --- |
| 2 | description: 'Required instructions for creating all commit messages - Brought to you by microsoft/edge-ai' |
| 3 | maturity: stable |
| 4 | --- |
| 5 | |
| 6 | # Commit Message Guidelines |
| 7 | |
| 8 | This document provides instructions for generating standardized commit messages. |
| 9 | |
| 10 | ## Format Requirements |
| 11 | |
| 12 | - Use Conventional Commit Messages |
| 13 | - All changes MUST be in imperative mood |
| 14 | |
| 15 | ## Types |
| 16 | |
| 17 | Types MUST be one of the following: |
| 18 | |
| 19 | - `feat` - A new feature |
| 20 | - `fix` - A bug fix |
| 21 | - `refactor` - A code change that neither fixes a bug nor adds a feature |
| 22 | - `perf` - A code change that improves performance |
| 23 | - `style` - Changes that do not affect the meaning of the code |
| 24 | - `test` - Adding missing tests or correcting existing tests |
| 25 | - `docs` - Documentation only changes (excluding: `*.instructions.md`, `*.prompt.md`, `*.agent.md`, as these are prompts and instructions likely meaning the changes are `feat`, `chore`, etc) |
| 26 | - `build` - Changes that affect the build system or external dependencies |
| 27 | - `ops` - Changes to operational components |
| 28 | - `chore` - Other changes that don't modify src or test files |
| 29 | |
| 30 | ## Scopes |
| 31 | |
| 32 | Scopes MUST be one of the following: |
| 33 | |
| 34 | - `(prompts)` |
| 35 | - `(instructions)` |
| 36 | - `(settings)` |
| 37 | - `(cloud)` |
| 38 | - `(edge)` |
| 39 | - `(application)` |
| 40 | - `(tools)` |
| 41 | - `(resource-group)` |
| 42 | - `(security-identity)` |
| 43 | - `(observability)` |
| 44 | - `(data)` |
| 45 | - `(fabric)` |
| 46 | - `(messaging)` |
| 47 | - `(vm-host)` |
| 48 | - `(cncf-cluster)` |
| 49 | - `(iot-ops)` |
| 50 | - `(blueprints)` |
| 51 | - `(terraform)` |
| 52 | - `(bicep)` |
| 53 | - `(scripts)` |
| 54 | - `(adrs)` |
| 55 | - `(build)` |
| 56 | - `(azureml)` |
| 57 | |
| 58 | ## Description |
| 59 | |
| 60 | - Description MUST be short and LESS THAN 100 bytes |
| 61 | - Examples: |
| 62 | |
| 63 | ```txt |
| 64 | feat: update logic with new feature |
| 65 | chore: cleaned up and moved code from A to B |
| 66 | feat(iot-ops): add parameters to take name instead of id |
| 67 | ``` |
| 68 | |
| 69 | ## Body (Optional) |
| 70 | |
| 71 | For larger changes only: |
| 72 | |
| 73 | - Body starts with a blank line |
| 74 | - Contains a summarized bulleted list (0-5 items AT MOST) |
| 75 | - MUST be LESS THAN 300 bytes |
| 76 | |
| 77 | ## Footer |
| 78 | |
| 79 | - Footer MUST start with a blank line |
| 80 | - Must include an emoji that represents the change |
| 81 | - Must end with `- Generated by Copilot` |
| 82 | |
| 83 | ## Example Complete Commit Message - Large |
| 84 | |
| 85 | ```txt |
| 86 | feat(cloud): add new authentication flow |
| 87 | |
| 88 | - add commit message, markdown, C# along with C# test instructions |
| 89 | - introduce task planner and researcher, prompt builder, and adr creation agents |
| 90 | - configure markdownlint and VS Code workspace settings |
| 91 | - add ADO work items prompts for getting and preparing my work items |
| 92 | - add .gitignore and cleanup README newlines |
| 93 | |
| 94 | 🔒 - Generated by Copilot |
| 95 | ``` |
| 96 | |
| 97 | ## Example Complete Commit Message - Medium to Small |
| 98 | |
| 99 | ```txt |
| 100 | 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 |
| 101 | |
| 102 | 🔒 - Generated by Copilot |
| 103 | ``` |
| 104 | |