tvkitchen / meta

A meta repository for discussions and tasks that span the project
Apache License 2.0
1 stars 0 forks source link

Lets talk conventional commits #5

Open slifty opened 4 years ago

slifty commented 4 years ago

Discussion

What do you want to talk about?

We have bounced around the idea of using conventional commits in this project.

The positives of this approach is that there is semantic metadata around the nature of a given commit, and there is tooling out there that knows how to understand that metadata and automate things like versioning.

The negative is that it seems a little anti-human to have a bunch of semantic jargon in human readable fields. I can't tell if this is something we would all get used to, but I am sympathetic to that concern.

On the flip side, once you get used to it that jargon does provide information even to our feeble human brains.

There are alternatives to conventional commits, such as gitmoji, which provide a more human (and more concise) value to the commit message. These don't provide the semantic benefit of conventional commits, and so the tooling isn't as robust (might not even exist).

So, lets talk about it.

  1. Should we move to conventional commits?
  2. Should we move to something like gitmoji?
  3. Should we do both?

At the very least we want to identify a standard way to convey semver-relevant information in commits, which is a first class use case of conventional commits.

Relevant Resources / Research

Laurian commented 4 years ago

cats

slifty commented 4 years ago

omg plz yes conventional cat-mits

Laurian commented 4 years ago

Can we have instead of a commit message like in https://github.com/tvkitchen/base/commit/8090b41c38deda086bfdc476e1feeb201571b704

a generated CATS image?

Screenshot 2020-06-14 at 19 27 09
Laurian commented 4 years ago

yeah, cat-mits and purr-requests…