Repository with sources and generator of https://larlet.fr/david/ https://larlet.fr/david/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

index.md 1.5KB

12345678910111213141516
  1. title: Commit (hi)story
  2. lang: en
  3. > There is one tool that we under utilise in our communities for communicating our intent and that is our version control system. […]
  4. >
  5. > Our commit history has some very special properties which make it particularly useful for documenting intent.
  6. >
  7. > It is kept forever.
  8. >
  9. > It is always up to date and this almost certainly not true of most of the documentation you have, perhaps in a wiki or even in code comments.
  10. >
  11. > And, this may come as a surprise to some of you, it is searchable.
  12. >
  13. > <cite>*[Telling stories through your commits](https://blog.mocoso.co.uk/talks/2015/01/12/telling-stories-through-your-commits/)* ([cache](/david/cache/13d9da5621e5616aee2248696390c693/))</cite>
  14. Even if I try to write [good commit messages](https://chris.beams.io/posts/git-commit/) ([cache](/david/cache/47c163111260f462fa10532e784a4c44/)), I never thought about actually using it as an [up-to-date line by line documentation](https://about.futurelearn.com/blog/telling-stories-with-your-git-history) ([cache](/david/cache/3298d68a0ad3d267742d80811213d628/)). Which lead me to think about a more friendly way to visualize it. Using [git blame or any other git trickery](https://mislav.net/2014/02/hidden-documentation/) ([cache](/david/cache/d92f0d39965b2b41d2701d3a6a114c3c/)) is a bit too nerdy for me. I’m still looking for the most [appropriated plugin](https://packagecontrol.io/search/git?sort=popularity) for my editor which would display the commit message related to each line without the hurdle of doing it by hand.