Make conventional commits more explicit

[Smankusors]

Proposed changes

I updated the PR template and the contributing doc, so that it's easier for the first time contributors and us reviewers when handling the conventional commits format. Let me know what do you guys think 😉

(also merge two similiar checklist as one about change in docs)

Screenshots (if appropriate) or codepen:

n/a

Types of changes

• Bug fix (non-breaking change which fixes an issue).
• New feature (non-breaking change which adds functionality).
• Breaking change (fix or feature that would cause existing functionality to change).

Checklist:

• I have read the CONTRIBUTING document.
• My commit messages follows the conventional commit format
• My change requires a change to the documentation, and updated it accordingly.
• I have added tests to cover my changes.
• All new and existing tests passed.

[DyegoCosta]

What about add a git commit hook instead? https://github.com/conventional-changelog/commitlint/#add-hook
Seems reasonably fast on my machine.

[DanielRuf]

@DyegoCosta that's what husky does, setting up Git hooks.

In our setup it runs commitlint when a new commit is created.

https://github.com/materializecss/materialize/blob/main/.husky/commit-msg

https://github.com/materializecss/materialize/blob/main/package.json#L60

I think we should upgrade husky to the latest available version. Afaik it also needs a prepare script in package.json.

@wuda-io wants to check why it does not work. I guess this is due to the newer Git version which is not supported by husky or we forgot the prepare script. An upgrade of husky might be the easiest solution.

[DyegoCosta]

OH I did not notice we had that already in the project, I think my local was behind the upstream. Wouldn't be better to fix it instead of adding this new checkbox then? I added it to my outdated branch (with this command) and it worked as expected (screenshot above).

[wuda-io]

I think it only works on Unix machines, I will test it.
But since it is checked locally, it can bypassed anyhow, so an additional checkbox is not bad as reminder.

[LoganTann]

Proposals approved

[Smankusors]

@DyegoCosta sadly the commit hook doesn't work when the contributor edited directly from github.com or github.dev 😞

[DanielRuf]

@Smankusors that is as expected since the browser-based IDE has no real shell environment.

That should not be a problem for us. As we plan to onboard more members with write access, there will be more volunteers who can fix commit messages in PRs if needed.