[–] java-man 6y ago ↗ 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
[–] theom 6y ago ↗ 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."
2 comments
[ 2.8 ms ] story [ 15.0 ms ] threadA better approach might be this:
- add ticket number to every git commit
- one line comment describing the goal of the change
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."