From fd8515401e6b7c1e83a11387090e2121578f0a88 Mon Sep 17 00:00:00 2001 From: Auguste Baum Date: Mon, 30 Sep 2024 13:33:22 +0200 Subject: [PATCH] add docs --- CONTRIBUTING.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 79eb2df2f..fca98e0e6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -70,6 +70,14 @@ Then, you can access the local build via: open doc/_build/html/index.html ``` +### PR format + +We use the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) format, and we automatically check that the PR title fits this format. +In particular, commits are "sentence case", meaning "fix: Fix issue" passes, while "fix: fix issue" doesn't. +Our custom set of rules is in [commitlint.config.js](./commitlint.config.js). + +Generally the description of a commit should start with a verb in the imperative voice, so that it would properly complete the sentence: "When applied, this commit will [...]". + ## Help for common issues ### `make build-frontend` doesn't work!