Welcome to the Machine Learning Blog

Git Commits Should Look Professional???

Did you know you're supposed to format your commits? And not just write vaguely entertaining reminders to yourself like "Filled in some_function() but there's 3 nested for loops WHY WOULD GOD DO THIS TO ME?!" Just kidding, I would never write that. You can't write a commit message with exclamation points.

This is the git commit formatting Udacity uses:

feat: Summarize changes in around 50 characters or less

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 the commit 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); various tools like `log`, `shortlog`
and `rebase` can get confused if you run the two together.

Explain the problem that this commit is solving. Focus on why you
are making this change as opposed to how (the code explains that).
Are there side effects or other unintuitive consequences of this
change? Here's the place to explain them.

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

If you use an issue tracker, put references to them at the bottom,
like this:

Resolves: #123
See also: #456, #789

That's way more professional than about a third of my commits that just say "Updated ." But now I know! And you know! Education!!

links

social