Add guideline for commit messages

[programmiri]

What?

We want to add a guideline for writing commit messages. This will make our commit history more consistent.

It will be part of / added to a CONTRIBUTING file later.

[programmiri]

Suggestions

• we could use uses semantic commit messages, which can help in streamlining release processes (auto generating CHANGELOGs)
  • these could be used in combination with defined emojis to have a more visual effect (see e.g. https://github.com/folke/devmoji)
• we establish rules based on How to Write a Git Commit Message

[jlprat]

I like the guidelines under https://www.conventionalcommits.org/en/v1.0.0/

[SmuliS]

I also think that Conventional Commits is a good default and we should not try to reinvent the wheel. I would describe the commit type with text label instead of emojis. Emojis look nice in GitHub, but they are not as explicit with some text based tools.

Do you think we should repeat the (copy) the main points to the document or only refer to that external resource?

[programmiri]

Sounds good to me! 👯

I would add the main points in our doc in form of a condensed bullet list which is fast to skim, while refer to the external resources for more details. That way, the contributors don't have to leave the source in most cases (if they don't want to read up more details), which I feel is a nice usability. At least for people that tend to be a bit impatient (or eager, which is a nicer way to put it 😅 ) like me.

I can make a PR for that.

❓ should I already make that a CONTRIBUTING file or should it be a temp commits.md until we have CONTRIBUTING and move it over?

[SmuliS]

Lets add the guide directly to CONTRIBUTING. I think it does not need to be complete from first commit as we have #99 that describes the desired state.

[programmiri]

Thanks! Then I'll make a PR for that 🏃