2 ms·
Why not document it then? In a place where everyone can read it, instead of only developers.
by mixmastamyk 3y ago
Why not document it then? In a place where everyone can read it, instead of only developers.
- Izkata 3y ago...are you suggesting spending hours searching through documentation, hoping to possibly find something relevant, instead of just being able to run "git blame" to see why a specific line was changed?
- mixmastamyk 3y agoI use blame often to blame. Code tells how, not why—the domain of specs and comments. Commit messages effectively don’t exist for non-developers. I put spec links in doc strings whenever possible. They are accessible to everyone—devs, PMs, SMEs, stakeholders that pay bills, and myself when at a web browser. Searching is not required but even if it was it would be a tiny fraction of “hours.”