Tiffany Le-Nguyen
Staff Frontend Engineer at Netlify ✈️
Clear and consistent git practices for better versioning and communication
Why should you care about commit messages/PR templates?
-
To speed up the reviewing process 🚤
-
To help write good release notes 📝
-
To help the future maintainers (it could be you!) 🔮
-
To make it easier to debug and revert
Commit Inconsistencies
Commit message best practices
git-scm
- < 50 characters
- A present tense action verb (Add/Update) followed by what was changed
- Capitalization of the first letter
- No period at the end (it's a title)
- Each commit should be focused on one specific purpose
Template by Tim Pope
Short (50 chars or less) summary of changes
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.
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 heregitmojis
Subtitle
How to use emojis
$ git commit -m ":sparkles: Add super awesome feature"✨ Add super awesome featureUsing Rocket (Mac)
Useful Pull Requests
What about issues?
What we're missing out on as GitHub Enterprise 2.11 :(
Multiple issue templates
GitHub Apps
Team Discussions
More detailed releases
- https://blog.github.com/2018-03-27-github-enterprise-release-2-13/
- https://blog.github.com/2018-07-12-introducing-enterprise-2-14/
git best practices
By Tiffany Le-Nguyen
git best practices
Commit best practices, emojis, pr and issue templates and what we're missing out on
