Git Commits
Writing good commit messages for granual commmits helps project management and makes reviewing those changes easier. This document outlines what engineers should and must do.
Must
- Include the related Jira issue ID (when one exists) in the commit message. These are always 2+ capital letters followed by a dash and then at least one number, such as
VOK-123. - If a commit contains changes related to muliple Jira issues, include all those IDs separated by a comma and space, such as
VOK-123, VOK-456.
Should
- Try to avoid changes to mulitple features and Jira issues within the same commit.
- If a single Jira issue contains multiple features, make a commit for each feature that includes the same Jira ID.
- Briefly explain what the commit does, usually in terms of the topics
add,fix,revert, orrelease. - Prefer many, more-granular commits over fewer, larger commits.
Examples
VOK-123: adds dropdown menu in promo section of home screenAdd dropdown menu in promo section of home screen. (VOK-123)
These messages includes the Jira ID, as well as a concise description of what was done and where it can be found.
Jira Integration
Jira issues IDs are required because they allow Jira to link the issue back to the related commits in GitHub. This makes it easier to account for each change being made. Jira has additional integration options that allow commit messages to transition issues. You may use those if you like.