Chore/contributing

[mgermerie]

Before contributing

Read CONTRIBUTING.md and CODING.md to apply iTowns conventions on PRs, Git history and code.

Description

Fix typo in CONTRIBUTING.md and add a comprehensive list of commit types we support for changelog generation.

Motivation and Context

Between v2.38.0 and v2.40.0, too many commits were merged while not fully respecting the convention, breaking the automatic changelog creation and requiring some manual fixing. As already discussed, a comprehensive list of commit types will help reducing this kind of issues. I also want to set @iTowns/reviewers attention on the fact that commits syntax should also be tediously checked before merging. Even a minor error like the lack of : in the commit message breaks the changelog creation. Here are some examples of what we merged and shouldn't have been :

• type(scope) message
• type (scope): message
• type(scope) : message

I might be forgetting a few, but the idea is to always check that the commits respect the type(scope): message convention before merging.

[gchoqueux]

You could try git hook

[jailln]

Thanks for the additions.

You could try git hook

I use git-hooks on other projects and it works well. I agree it would be a good improvement to avoid human mistakes :eyes:
@mgermerie do you want to do it in this PR or open an issue and do it later?

[mgermerie]

Thanks for the tip ! I'll do it in this PR.

[mgermerie]

I finally found out a github action that does the job of checking every commit names in a PR. I added it to the integration script and tested it, it works well.