ex_vcs_based_documentation.adoc

VCS as a source of Knowledge

• Doctor Who Tardis time machine animation

• Doctor Who - BBC

• Useful metadate

• Commit message (surtout s’ils sont bien faits voire atomic / monorepo)

• Conventional commit

• pull request notes

Commit messages…​

Good commit messages

Tells the WHY

Conventional Commit

The template

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Example 1

feat: allow provided config object to extend other configs

BREAKING CHANGE: `extends` key in config file is now used for extending other config files

Example 2

docs: correct spelling of CHANGELOG

• https://www.conventionalcommits.org/en/v1.0.0/

• https://www.conventionalcommits.org/en/v1.0.0/#summary

Generate Changelog

• Conventional Changelog

• Conventional Changelog

Git "blame"

1. is the new @author

Your code as a crime scene

• Treat Your Code as a Crime Scene • Adam Tornhill • GOTO 2016