Note: <\/strong>This is an opinionated piece focused specifically on infrastructure code, not application code. Standards may differ across organizations, but I am sharing this based on my experience.<\/p><\/blockquote>\n
Commit Standards<\/h2>\n
Usually, when working with infrastructure code, you pick tasks from Jira or other tools. These tasks may come from your own team or as tickets created by different teams.<\/p>\n
In either case, a basic commit standard should include the task ID, the action taken, and a brief description of the commit.<\/p>\n
[Jira-ID][Action] - Short Description <\/code><\/pre>\nAction could be Add, Update, Change, xChange, Delete,<\/strong> etc.<\/p>\n
For example,<\/p>\n
\n
- [Add]:<\/strong> To introduce new resources (e.g., add a load balancer<\/a>).<\/li>\n
- [Update]:<\/strong> For modifying existing resources (e.g., tweaking an EC2 instance type).<\/li>\n
- [Change]: <\/strong>For altering configurations or logic (e.g., modifying a VPC CIDR<\/a>).<\/li>\n
- [xChange]<\/strong>: For breaking changes that disrupt existing functionality (e.g., removing a legacy subnet routing table).<\/li>\n<\/ol>\n
Example: [CR-135][Add]<\/p>\n
After the – or :<\/strong>, add a brief message (50-72 characters ideally) describing what\u2019s being done.<\/p>\n
Avoid vague terms like “fix stuff”. Be specific.<\/p>\n
Few examples,<\/p>\n
\n
- [CR-135][Update] – Modify EC2 instance to t3.medium<\/li>\n
- [CR-152][Change]: Adjust subnet CIDR to 10.0.3.0\/24<\/li>\n
- [CR-167][Add]: New S3 bucket for logs<\/li>\n
- [CR-189][Update] – Fix prod bucket policy #deploy-prod<\/li>\n
- [CR-204][xChange]: Kicked out the old server, new one\u2019s the boss now<\/li>\n<\/ol>\n
Why task ID in commit?<\/p>\n
Because the task ID ties each commit directly to a specific task<\/strong> or ticket, making it easy to follow the trail from the code change back to the original purpose or requirement.<\/p>\n
This is especially useful in projects with multiple contributors or when you are debugging later and need to understand why a change was made<\/p>\n
\n\ud83d\udca1<\/div>\nEvery organization usually has its own well-documented standards for commit practices. If you are working in a company, be sure to follow their guidelines.<\/div>\n<\/div>\nJira Git Integration<\/h2>\n
Tools like Jira offer Git integrations that allow you to track each Jira story or task through commit<\/strong> messages.<\/p>\n
For example, each Jira ticket (e.g., CR-145) represents a specific infrastructure change.<\/p>\n
When a DevOps engineer<\/a> makes code changes for that Jira ticket, they simply need to include the task ID in the commit message<\/strong> using the standard format mentioned earlier.<\/p>\n
By including a task ID (e.g., INFRA-123) in the commit message, Jira\u2019s integration automatically scans and links<\/strong> the commit to the corresponding story, issue, or ticket in its system.<\/p>\n
This enables Jira to display details such as the number of branches, commits, and pull requests (PRs) associated with each task.<\/p>\n
![\"Git](\"https:\/\/storage.ghost.io\/c\/5f\/2f\/5f2f4d20-2abf-4534-8d40-7aa233aedd43\/content\/images\/2025\/03\/image-75-1.png\")