Patty Melts

One of the greatest food items is the patty melt. It's a burger, it's a sandwich, it's delicious.

As great dinner sandwiches go, it is hard to beat the patty melt

The patty melts deliciousness comes from the fact that's it's only four components. Rye bread, hamburger, Cheese, and grilled onions. The simplicity doesn't mean you can't customize it though. Dark, light, and marbled rye each add a different flavor, but the biggest way to customize it though is the choice of cheese. Swiss and American are the two classics, but I think cheddar and muenster also deserve consideration.

BONUS: If you want to make the patty melt even better, make sure to include a pickle on the side for dessert.

A patty melt with a side of fries and pickles in a bag

Commit Messages are about Intent

Commit messages are user experience for developers.  Both for other developers active right now and for developers (including ourselves) days/years/months from now. Think about the last time you were looking at a piece of code and asked yourself “Why is this here”.  This is for you, this is your experience. I shared my four rules of thumb for commit messages, this is a little more in-depth.

Caleb Thompson proposes three questions that all commit messages should answer:

  • Why is this change necessary?

  • How does it address the issue?

  • What side effects does this change have?

In general, the first and second is the easiest to answer. In many cases, a link to your bug tracker will suffice (at least in part) for the first question. Your bug tracker should already contain the *why* for every change requested. The second question  is important when the solution is complex.

Does this mean that all commit messages need to be bland? Absolutely not. WORLD WAR Z-INDEX: Restoration of sanity to revisions/slider/menu z-index values. is an excellent example of a commit message that is both fun and informative. The changeset is small ( 3 lines changed, 4 deleted), and is fairly easy for us to answer the question “What is changed?”. The why is answered with both a link to the ticket of

Erlang/OTP identifies three important purposes that commit messages serve:

Good commit messages serve at least three important purposes:

  • To speed up the reviewing process.
  • To help us write a good release note.
  • To help the future maintainers of Erlang/OTP (it could be you!), say five years into the future, to find out why a particular change was made to the code or why a specific feature was added.

The third reason to me is likely the most important.  Boone Gorges identifies blaming and annotation to be important tools in understanding the history of code and history of decisions in his talk Building a Better WordPress through Software Archaeology. Our software has a history and commit messages are the first draft of that history.

 

Further reading:

Commit Often, Perfect Later, Publish Once: Git Best Practices

Best Practices vary from environment to environment, and there is no One True Answer, but still, this represents a consensus from #git and in some cases helps you frame the discussion for the generation of your very own best practices.

On commit messages

Any software project is a collaborative project. It has at least two developers, the original developer and the original developer a few weeks or months later when the train of thought has long left the station. This later self needs to reestablish the context of a particular piece of code each time a new bug occurs or a new feature needs to be implemented.

5 Useful Tips For A Better Commit Message 

Having a story in your git log will make a huge difference in how you and others perceive your project. By taking great care in commit messages, as you do in your code, you will help to increase overall quality.

The Art of the Commit

Think of the commit log as a newsfeed for your project, in which the log message is the headline for each commit. Have you ever skimmed the headlines in a newspaper (or, for a more current example, BuzzFeed) and come away thinking you’d gotten a summary of what was happening in the world? A good headline doesn’t have to tell the whole story, but it should tell you enough to know what the story is about before you read it.

Omnivore normative behavior

When reading about responsive web design, you’ll often come across the term “Hamburger Menu” and it will sometimes make me hungry. But it won’t make everyone hungry. It won’t make vegetarians hungry.  Nor pescetarians.

We live in an omnivore normative society where the assumption is often made that meat eating is normal and all else is the exception. Damn Omnivore Normative Behavior.

My current podcast subscriptions

One thing that I like about commuting versus working from home is that it gives me a specific buffer period where I can transition between working and not working. I use this buffer period to listen to music and podcasts and tend to go in phases where one is dominant.  Right now, podcasts are dominating.  Here is what I am currently listening to.

Girl Friday

Erin Gloria Ryan hosts a discussion that comes out every Friday that centers on the media, but especially woman’s experiences. The “Man Displeased” segment at the end helps show the comments that woman, but especially woman in the public eye, face.

All Songs Considered

NPR’s music podcast that introduces me to great music.

How I Built This

An interview by Guy Raz of NPR with someone that founded a company. It’s great to hear the stories of how companies that I respect came to be.

This Land Is Our Land

This started as a podcast focused on the trial of the Malheur refuge occupiers, but has also done a good job exploring land rights issues.

Leader.Team

It seems to have gone on hiatus, but Cory and Matt do a great job of exploring what it means to be a leader, especially in the context of engineering leadership.

Post Status Draft

The one WordPress podcast I listen to.  Joe and Brian have a great discussion about both current events in the WordPress community and evergreen topics like teaching yourself.

99% Invisible

Taking its name from the phrase “Ninety-nine percent of who you are is invisible and untouchable.”, this podcast looks at the hidden parts of design and how they influence who we are.

Savage Lovecast

Dan Savage serves up great advice every week in the humorous way that he is known for.

Wait Wait… Don’t Tell Me!

The NPR news quiz, in podcast form.  I dream of being a contestant or panelist.

Gears! Gears! Gears!

I bought my friend’s three-year-old son Gears! Gears! Gears! as a holiday present and he absolutely loved it. Within moments of unwrapping it, he was building machines. The surprising part was just how much and his mom and I loved it as well.  If you are looking for for a STEM toy for a three-year-old who you want to encourage to be creative and build things, I recommend Gears! Gears! Gears!.