The Arctic Ice Studio Git Style Guide.
To present Git commits and branches in an organized, standardized, and easy-to-read manner, this official style guide describes how the content should be structured, spelled and formatted in all Arctic Ice Studio projects.
There are only some strict rules but mostly guidelines since we are more interested in content than formatting and the review process may help contributors to conform to this guide later on.
Commit messages are important parts of communication between contributors and for the lifecycle of the project: its past and its future. It is the only place that captures not only what was changed, but why.
For open source project communities it is important to maintain good habits of communication in all forms. A well-crafted commit message can save a lot of time and overhead and helps to speed up development processes.
Structural Split of Changes
If a code change can be split into a sequence of patches/commits, then it should be split. Less is not more.
The cardinal rule for creating good commits is to ensure there is only one logical change per commit. There are many reasons why this is an important rule:
- The smaller the amount of code being changed, the quicker and easier it is to review and identify potential flaws.
- Revert broken commits is much easier if there are not other unrelated code changes entangled with the original commit if a change is found to be flawed later.
- Small well defined changes will aid in isolating exactly where the code problem was introduced when troubleshooting problems using Git's
- Small well defined changes aid in isolating exactly where- and why a piece of code came from when browsing history using Git
- Mixing whitespace changes with functional code changes. The whitespace changes will obscure the important functional changes, making it harder for a reviewer to correctly determine whether the change is correct.
- The change should be split into two commits, one with the whitespace changes, one with the functional changes.
- Mixing two unrelated functional changes. Without a structural split of changes it will be harder to identify flaws if two unrelated changes are mixed together. If it becomes necessary to later revert a broken commit, the two unrelated changes will need to be untangled, with further risk of bug creation.
- Sending large new features in a single giant commit. The code for a new feature is only useful when all of it is present, but this does not imply that the entire feature should be provided in a single commit.
- New features may entail refactoring existing code so it is highly desirable that any refactoring is done in commits which are separate from those implementing the new feature. This helps reviewers and test suites validate that the refactoring has no unintentional functional changes.
- Newly written code can often be split up into multiple pieces that can be independently reviewed. For example, changes which add new internal APIs/classes, can be in self-contained commits leading to easier code review and allows other developers to cherry-pick small parts of the work, if the entire new feature is not immediately ready for merge.
- Code that affects public APIs should be done in commits separate from the actual internal implementation. This will encourage the author and reviewers to think about the generic API design, and not simply pick a design that is easier for their currently chosen internal implementation.
The commit message must contain all the information required to fully understand & review the patch. Less is not more.
As important as the content of the change, is the content of the commit message describing it. The purpose of a commit message is to summarize a change, but the purpose of summarizing a change is to help to understand the code. The information to be put into a message should be valuable and useful for reviewers and the projects community.
Having a story in the Git history will make a huge difference in how others perceive the project. Taking great care in commit messages will help to increase the long-term overall quality.
- The first line is important. The message summary of the commit has special significance. It is used in many places like the Git history headline, git annotate- and merge messages or email subject lines where space is at a premium. As well as summarizing the change itself, it should take care to detail what part of the code is affected.
- Describe the intent and motivation behind the changes. Describe why the code has been written this way and document the overall code structure in the message body, particularly for large changes.
- Include the GitHub issue ID and additional references in the message footer. This will automatically fire some hooks to track the commit in related GitHub repository issues- and pull requests and is required to contribute to a project.
- Reviewers can understand what the original problem was. The commit message should have a clear statement as to what the original problem is. The GitHub issue ID is merely interesting historical background on how the problem was identified and has been discussed within the community, but it should be possbile to review a proposed patch for correctness without having to read the whole ticket.
Elements and their Structure
A Git commit message follows this format:
<summary> <body> <footer>
The first line is the one-sentence concise subject about the changes introduced by the commit. The optimal total size of characters is 50 or less, but is limited to 72 characters and does not ended with a period. It uses the imperative mood and is separated from the message body by a single blank line.
Technical details that cannot be expressed in these strict size constraints should be put in the message body instead.
The detailed description about the changes of the commit should be split into multiple logically separate paragraphs if necessary. It uses the imperative mood and the lines are wrapped at 72 characters.
This metadata block must contain the GitHub issue ID and is separated from the message body by a single blank line.
Multiple issues are separated by a comma and additional references can be added in the next lines.
A branch should reflect the story of the commits it contains using a valuable and useful name to clarify its purpose during the development lifecycle and the persistency in the history.
Arctic Ice Studio follows the gitflow branching model with the deviations and additional conventions described below.
Branches are an important major component for building open source projects regardless of the size. A well maintained branch merge story in the history will help to increase the long-term overall quality.
The two infinite development lifecycle core branches must be lowercase named
The lowercase name of a limited development lifecycle story branch must reflect the type separated by a slash from the issue ID and followed by the short and descriptive title using hypen delimiters.
Story Type Prefixes
Every branch must contain issue ID which is important to automatically fire some hooks to track the commit in the related GitHub repository issues and pull requests and is required to contribute to a project.
release branch is used to prepare a new tagged release version.
- Only use annotated tags. Allows to include the name of the project followed by the version number to the commit message.
- Always add the
vprefix character to version tags. Clarifies the tag type as specified by ArcVer.
- Every version tag must be signed. Ensures that the version has been tested and approved by the project owner or an authorized project contributor.