On: Who wrote this shit?

[sillysaurusx]

I fixed a bug the other day that I was so embarrassed about, I intentionally left the commit message cryptic.

(It was a personal project.)

Sometimes the best documentation is seared into your soul as a mark of shame. I think I’ll wake up a few times wincing about it.

[Red_Leaves_Flyy → sillysaurusx]

Spare me your shame.

Should someone inherit your project and end up fixing another bug in that part of the code they may be benefit from any information you share.

Shame is temporary, public repos are not.

[dwaltrip → sillysaurusx]

To err is human. Don’t feel bad about it. You fixed it :)

(I say this as someone who has a track record of being too hard on myself!)

[JKCalhoun → sillysaurusx]

A team I worked with had a fun little habit I have since borrowed: you add a "BOGUS" comment next to the offending line. Sort of like:

// BOGUS: assuming 'x' will never be greater than 1024.

Sort of tells future engineers, yeah, I know it's shit.

[johnmaguire → JKCalhoun]

// I'm so sorry...

A comment I left that I am sometimes reminded of by ex-coworkers still at that company.