interblah.net - Two thoughts about maintainable softwarehttps://interblah.net/two-thoughts-about-maintainable-software
Starts with the idea that the 'why' of software is important, and needs to be captured. Then looks at where to keep that why and suggests that the best place is actually in the commit messages, not the comments, because that better captures the temporal context of the changes.
I definitely agree with capturing that in the same repository as the code rather than spread out over many systems, but not sure I agree with just the commit messages. Regardless it's definitely worth thinking through the details for whatever project you're working on.
Related By Tags
- 🔗 The Eternal Mainframe
- 🔗 Blog | Documenting Architecture Decisions | Relevance
- 🔗 The Rise and Fall of Commercial Smalltalk | Allen Wirfs-Brock
- 🔗 Geek Blight - Origins of the youtube-dl project
- 🔗 Being a responsible subsystem – Jessitron
- 🔗 An Unbelievable Demo
- 🔗 Managing Research Software Projects
- 🔗 Sociotechnical Lenses into Software Systems | Paul Osman
- 🔗 How Big Tech Runs Tech Projects and the Curious Absence of Scrum - The Pragmatic Engineer
- 🔗 The Art of Documentation – Chelsea Troy