Conventional Commits

This project uses conventional commits for Pull Request titles, as they are used as the commit names on the main branch. What are conventional commits? In the words of the official documentation:

The Conventional Commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of.

The PR titles should thus take the general form:

<type>[optional scope]: <description>

An example would be:

fix(types): make all floats double

Valid types for Caml are as follows:

We use the following regex to validate PR titles (test it!:

^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test|release)(.+)?(!)?:\ .+
Back to top