Prompt file imported from oliviasmim/ai-refactoring-resources (.github/prompts/commit-message-guide.prompt.md). Copyright stays with the author.

Commit Message Guidelines

Name: commit-message-guide
Author: oliviasmim

Format

All commit messages must follow this format:

<type>(<scope>): [<JIRA-XXX>] <description>

Types

Choose one of these types:

feat: A new feature
fix: A bug fix
chore: Routine tasks, maintenance
docs: Documentation changes
style: Formatting, missing semicolons, etc (no code change)
refactor: Code refactoring
test: Adding or modifying tests
perf: Performance improvements

Scope (Optional)

The scope indicates the module or component affected, such as:

auth
api
ui
deps
etc.

JIRA ID

Always include the JIRA ticket ID in square brackets. if you don't have a JIRA ticket, you cannot commit. ASK FOR A TICKET FIRST IF THE USER DON'T PROVIDE.

Description

Use present tense ("Add feature" not "Added feature")
Use imperative mood ("Move cursor to..." not "Moves cursor to...")
Do not end with a period
Keep it concise (under 72 characters)

Examples

✅ Good examples:

feat(auth): [SCRUM-1] Add user authentication API
fix(login): [SCRUM-42] Fix validation on login form
chore(deps): [SCRUM-123] Update dependencies to latest versions
docs(readme): [SCRUM-45] Update installation instructions
style(component): [SCRUM-67] Format code according to style guide
refactor(utils): [SCRUM-89] Simplify data processing logic
test(api): [SCRUM-99] Add tests for edge cases
perf(rendering): [SCRUM-210] Optimize list rendering performance

❌ Bad examples:

fixed bug                      // No type, scope, JIRA ID, or clear description
[SCRUM-42] updated some stuff  // No type or clear description
feat: did things               // No JIRA ID or clear description

Pro Tip

Consider using a Git commit template or a tool like Commitizen to help format your commit messages correctly.

{ "prompt": "# Commit Message Guidelines\n\n## Format\nAll commit messages must follow this format:\n```\n<type>(<scope>): [<JIRA-XXX>] <description>\n```\n\n## Types\nChoose one of these types:\n- `feat`: A new feature\n- `fix`: A bug fix\n- `chore`: Routine tasks, maintenance\n- `docs`: Documentation changes\n- `style`: Formatting, missing semicolons, etc (no code change)\n- `refactor`: Code refactoring\n- `test`: Adding or modifying tests\n- `perf`: Performance improvements\n\n## Scope (Optional)\nThe scope indicates the module or component affected, such as:\n- `auth`\n- `api`\n- `ui`\n- `deps`\n- etc.\n\n## JIRA ID\nAlways include the JIRA ticket ID in square brackets.\nif you don't have a JIRA ticket, you cannot commit.\nASK FOR A TICKET FIRST IF THE USER DON'T PROVIDE.\n\n## Description\n- Use present tense (\"Add feature\" not \"Added feature\")\n- Use imperative mood (\"Move cursor to...\" not \"Moves cursor to...\")\n- Do not end with a period\n- Keep it concise (under 72 characters)\n\n## Examples\n✅ Good examples:\n```\nfeat(auth): [SCRUM-1] Add user authentication API\nfix(login): [SCRUM-42] Fix validation on login form\nchore(deps): [SCRUM-123] Update dependencies to latest versions\ndocs(readme): [SCRUM-45] Update installation instructions\nstyle(component): [SCRUM-67] Format code according to style guide\nrefactor(utils): [SCRUM-89] Simplify data processing logic\ntest(api): [SCRUM-99] Add tests for edge cases\nperf(rendering): [SCRUM-210] Optimize list rendering performance\n```\n\n❌ Bad examples:\n```\nfixed bug // No type, scope, JIRA ID, or clear description\n[SCRUM-42] updated some stuff // No type or clear description\nfeat: did things // No JIRA ID or clear description\n```\n\n## Pro Tip\nConsider using a Git commit template or a tool like Commitizen to help format your commit messages correctly.", "variables": [], "notes": "❌ Bad examples: ``` fixed bug // No type, scope, JIRA ID, or clear description [SCRUM-42] updated some stuff // No type or clear description feat: did things // No JIRA ID or clear description ```", "metadata": { "source": { "provider": "github-prompts", "repository": "https://github.com/oliviasmim/ai-refactoring-resources", "path": ".github/prompts/commit-message-guide.prompt.md", "ref": "a814cd590cf77c50cbd1743352b19f6cf157569c", "url": "https://github.com/oliviasmim/ai-refactoring-resources/blob/a814cd590cf77c50cbd1743352b19f6cf157569c/.github/prompts/commit-message-guide.prompt.md", "key": "oliviasmim/ai-refactoring-resources/.github/prompts/commit-message-guide.prompt.md" } } }

commit-message-guide

About

Commit Message Guidelines

Format

Types

Scope (Optional)

JIRA ID

Description

Examples

Pro Tip

Use it

Manifest

Reviews