top | item 36520914

(no title)

eequah9L | 2 years ago

I like how this applies to commit messages and patchset cover letters as well. You write the whys and wherefores to both explain to others what's going on, as well as to make sure you understand yourself. For sure that increases your audience, nobody cared about your fix before! And you need to narrate all this -- a patch that fixes an issue should read a little bit like a whodunnit. What the issue is, how to trigger it, what the impact is, how the patch fixes it.

discuss

order

maxFlow|2 years ago

Thanks for mentioning this. I don't get to do much writing in my time off work, since that time is devoted to (more) coding to try and make my side project into a business. So what I do to compensate is I make an effort and write all commit messages, descriptions, code review comments and documentation as if I were writing for an audience of top engineers auditing my work. I find this approach makes me enjoy the process more, be more deliberate about my actions, and how I communicate them. Even a dull runbook can be beautifully written.