Category Archives: tech
Who are you writing that commit message for?
Next time you write a commit message, try some of these suggestions as your imaginary audience:
- Yourself, next week, when you finally get back to working on this thing and can’t remember where you were up to
- Yourself, when you get a pull request review and can’t remember which commit something is in that needs to be removed
- Yourself, debugging how this ended up like this, 6 months from now
- Your colleague, eyeballing your work to see how you are getting on
Personally, I think of it as a note to myself. Like an alibi, if someone asks you what’s already been done, or what this commit that removes one specific line from a long config file. Yes, I worked as a git consultant for a while, the delete-a-single-line with the commit message “Fixed” is always the culprit!
Further reading: https://cbea.ms/git-commit/
Weekly Planning with Obsidian
VSCode setup for technical writers
Sphinx front matter and template variables
Use Database Connection Strings with Laravel 8
Hold Attention on the Virtual Stage
I don’t. Continue reading
Define Navigation Structure in a Sphinx Project
Best Things About Developer Advocacy
Measuring Repo Community Health with GitHub’s API
With that in mind, I wanted to look at GitHub’s Community Health measure of the repositories I’m responsible for. You can view each repo’s community page separately through the web interface (look under “Insights”) but that’s not especially scalable if you have a lot of projects to track.