Feature/add commit branch validation

[ArthurHtbk]

In an effort to put an end to the observed resurgence of sloppy commit messages and branch names amongst my students -such as git commit -m "booger aids" or even git checkout -b nouvelle_feature_a_gillou-, I took it upon myself to add those validations as pre-commit hooks via Husky.

Commit message validation

The expected format adheres to the Conventional Commits set of specifications. It goes as follows:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

The <type> can be feat: , fix: or others like build: , chore: ,ci: , docs: , style: , refactor: , perf: , test: . The <description> is a short message written using imperative mode (add last feature [...] instead of added for example) that effectively and accurately depicts the changes being made. The body and footers are optional and, IMHO, not necessary at this point of the training.

Branch name validation

I didn't follow the <type>/message-in-kebab-case convention because I would like my students to create one branch per user story. The expected format goes like this: S{number}US{number}/message-in-kebab-case (example: S3US14/fix-header). Feel free to adapt the validation pattern as you see fit! The regex: ^S\\d{1}US\\d{1,2}\/[a-z0-9]+(-[a-z0-9]+)*$.

Hope you like it!

[rocambille]

you have to update pnpn lock files as well ;)

[ArthurHtbk]

Yay!!! 🥳 📦

[rocambille]

Time to manage this one :)

Here are some propositions:

• Configure branch name validation with a "match anything" regex /.*/ by default (so the hook always pass) : defining a real pattern implictly turns on the validation
• Propose some kind of on/off button for commitlint