News for hackers. Stuff that matters.
Re:Git history makes great docs by theom on Tuesday March 10, 2020 @04:44PM (#22539502)
I agree that git is not a replacement for all docs, but I think that it can be a great component of a strong documentation process.

Git commit messages as docs is a great start to creating a useful written record more iteratively, as part of a daily effort - not a big "overhaul."

Re:Git history makes great docs by java-man on Tuesday March 10, 2020 @01:54PM (#22537744)
I would disagree: git history is no place to create [real] documentation.

A better approach might be this:

- add ticket number to every git commit

- one line comment describing the goal of the change