Shiny new commit styles
We just rolled out some redesigned commit blocks all over the site. They look a bit like this: There’s all kinds of nice additions — notably, we’ll show you the…
We just rolled out some redesigned commit blocks all over the site. They look a bit like this:
There’s all kinds of nice additions — notably, we’ll show you the full commit message anywhere a commit is displayed (with the +… button).
But the biggest change you’ll see is that we’ve started embracing the model for Git commit messages — a one line summary followed by an optional description. Tim Pope wrote about proper git commit messages a long while ago.
The gist of a great commit message is this:
Capitalized, short (50 chars or less) summary
More detailed explanatory text, if necessary. Wrap it to about 72
characters or so. In some contexts, the first line is treated as the
subject of an email and the rest of the text as the body. The blank
line separating the summary from the body is critical (unless you omit
the body entirely); tools like rebase can get confused if you run the
two together.
Write your commit message in the present tense: "Fix bug" and not "Fixed
bug." This convention matches up with commit messages generated by
commands like git merge and git revert.
Further paragraphs come after blank lines.
- Bullet points are okay, too
- Typically a hyphen or asterisk is used for the bullet, preceded by a
single space, with blank lines in between, but conventions vary here
- Use a hanging indent
If you follow these rules, your commit messages are going to look great on GitHub. And if not, we’ll try our best to make them look good anyway.
Of course, if you’re using GitHub for Mac, we do all of this for you. Just type in the fields and we’ll create a properly formatted message for you.
Hope you guys enjoy!
Written by
Related posts
![](https://github.blog/wp-content/uploads/2023/10/Collaboration-DarkMode-2.png?resize=400%2C212)
2024 is the biggest global election year in history. What’s at stake for developers?
GitHub is considering what is at stake for our users and platform, how we can take responsible action to support free and fair elections, and how developers contribute to resilient democratic processes.
![](https://github.blog/wp-content/uploads/2023/10/AI-DarkMode-2.png?resize=400%2C212)
GitHub named a Leader in the Gartner first-ever Magic Quadrant for AI Code Assistants
This year, as part of its annual Magic Quadrant series, Gartner published a first-of-its-kind report analyzing the state of play in the AI Code Assistants market–and named GitHub a Leader.
![AI in software development 2024 survey results with colorful graphics and percentages.](https://github.blog/wp-content/uploads/2024/08/ai-survey-header.png?resize=400%2C212)
Survey: The AI wave continues to grow on software development teams
We surveyed 2,000 people on software development teams at enterprises in the U.S., Brazil, India, and Germany about the use, experience, and expectations around generative AI tools in software development.