Created
January 6, 2025 08:35
-
-
Save Maxiviper117/9c1bfeae98798c27e7c8f5ad457b5acb to your computer and use it in GitHub Desktop.
Vscode Github Copilot Commit message instructions
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
{ | |
"github.copilot.chat.commitMessageGeneration.instructions": [ | |
{ | |
"text": "Generate commit messages following the Conventional Commits specification. Use the following structure strictly:\n\n<type>[optional scope]: <short description>\n\nOptional body: Include a detailed explanation of the change if necessary. Wrap text at 72 characters per line.\n\nOptional footer: Include metadata such as issue references or breaking changes. Use keywords like 'BREAKING CHANGE:' followed by an explanation, and reference issues with 'Closes #<issue_number>'.\n\nTypes must be one of the following:\n- feat: For introducing new features.\n- fix: For bug fixes.\n- docs: For documentation-only changes.\n- style: For changes that do not affect code functionality (e.g., formatting).\n- refactor: For code changes that neither fix a bug nor add a feature.\n- test: For adding or modifying tests.\n- chore: For non-code tasks such as updating dependencies.\n\nThe short description must be imperative (e.g., 'add feature', 'fix bug'), and avoid punctuation at the end. Scope is optional but encouraged to specify the affected area of the codebase (e.g., 'api', 'auth', 'ui'). Ensure clarity and consistency in the message." | |
} | |
] | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Generate commit messages following the Conventional Commits specification. Use the following structure strictly:
Optional Body:
Optional Footer:
BREAKING CHANGE:
followed by an explanation.Closes #<issue_number>
.Types must be one of the following:
The short description must:
Scope:
api
,auth
,ui
).Overall Goal: