ci: verify semantic pull requests

[Shinigami92]

In our last meeting we discussed that we want to allow only specific defined scopes so the CHANGELOG.md will get better updated automatically

This PR will add a guideline that explains which are good commit/PR titles and which are not (with historical real world examples and how to write them instead)

Also it will only allow a subset of types and scopes so the PR title must follow the new convention

Please note that the verifyCommit script doesn't need to be absolutely exact, as only the PR title is important at the end when merging the PR because we always use squash-merge rebase

Tip: You can check how we wrote commit messages in the history with following command:

git log --pretty=format:%s > commits.md

[codecov]

Codecov Report

Merging #1264 (46e468e) into main (f8c9f60) will decrease coverage by 0.01%.
The diff coverage is n/a.

❗ Current head 46e468e differs from pull request most recent head e8a010a. Consider uploading reports for the commit e8a010a to get more accurate results

@@            Coverage Diff             @@
##             main    #1264      +/-   ##
==========================================
- Coverage   99.63%   99.62%   -0.02%     
==========================================
  Files        2154     2156       +2     
  Lines      239914   237027    -2887     
  Branches     1007     1006       -1     
==========================================
- Hits       239039   236128    -2911     
- Misses        854      878      +24     
  Partials       21       21              

Impacted Files	Coverage Δ
src/modules/internet/user-agent.ts	81.74% <0.00%> (-6.35%)	⬇️
src/modules/git/index.ts	100.00% <0.00%> (ø)
src/locales/he/name/index.ts	100.00% <0.00%> (ø)
src/locales/he/address/city.ts	100.00% <0.00%> (ø)
src/locales/he/address/state.ts	100.00% <0.00%> (ø)
src/locales/he/address/street.ts	100.00% <0.00%> (ø)
src/locales/he/name/last_name.ts	100.00% <0.00%> (ø)
src/locales/he/address/country.ts	100.00% <0.00%> (ø)
src/locales/he/cell_phone/formats.ts	100.00% <0.00%> (ø)
src/locales/he/name/male_first_name.ts	100.00% <0.00%> (ø)
... and 9 more

[Shinigami92]

We need to discuss if we want a type revert or a scope revert (or both)?

So do we want e.g. feat(revert): , fix(revert): or chore(revert): where only feat and fix would showup in the changelog
or revert: which would also not showup in changelog 🤔

But using a type would be somewhat helpful as the git cli creates these prefixed commit messages automatically I assume

[ST-DDT]

We need to discuss if we want a type revert or a scope revert (or both)?

IMO we should allow type revert. Although this might be connected to a bugfix usually.

[Shinigami92]

Cannot name it infra yet, as it's not in the main branch 😅

[ST-DDT]

Please also add an example commit message for a changed locale file.