<aside> 🌏 This page is public.

</aside>

Issue

We currently don't have an agreed upon commit message convention. This makes it harder for new contributors and employees to come in. This RFC outlines proposals for a commit message convention.

Proposed solution

Convention

We currently practise three different commit message conventions. I propose we agree on a single one of them.

  1. Simple descriptive sentences that explain what's happening.

    👍 They are easy and don't require much checking

    👎 They often miss the context where things are happening though.

  2. [component] Change description which is like the first one, but describes the context of the change

    👍 Does not impose much syntax

    👍 Clarifies the context of the change which befits our monorepo

    👎 Provides no means for communicating breaking changes

  3. Conventional commits seem to be used intermittently by some folks

    👍 Very flexible in what it can communicate

    👎 Complex syntax that necessitates commit message checkers to be enforced

    👎 Will take some time to learn due to its complexity

Style

Other than convention we should agree on these rules of style

Notes/Resources

What are relevant documents, links, resources? Feel free to embed a Google Docs if you find it easier to review/collaborate there.