| name | Git Commit Conventions |
| description | Conventional commit format and workflow with Jira ticket integration |
Git Commit Conventions
Guidelines for creating properly formatted commit messages with Jira ticket numbers.
Configuration
Set your Jira project prefix in README.md:
# Project Configuration
- **Jira Ticket Prefix**: `PROJ` (e.g., JIRA, DEV, TASK)
- **Branch Format**: `<PREFIX>-<number>-description`
Conventional Commit Format
<type>: <PREFIX>-<ticket-number> <description>
Where:
<type> = Commit type (feat, fix, docs, etc.)
<PREFIX> = Your Jira project prefix (PROJ, JIRA, etc.)
<ticket-number> = Jira ticket number
<description> = Imperative description
No-ticket exception
If there is no ticket in the branch name and recent commits do not include tickets, omit the ticket and use:
<type>: <description>
Commit Types
| Type | Usage |
|---|
feat | A new feature |
fix | A bug fix |
|