From 99b30fb9d4958114174c9d7464e355deed9bd4c0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?K=C3=A9vin=20Commaille?= Date: Mon, 10 Jun 2024 21:19:38 +0200 Subject: [PATCH] docs: Document area prefix for commits --- CONTRIBUTING.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 03faab15..ab91a1d4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -137,6 +137,13 @@ use super::MyType; ### Commit Messages +The commit message should start with the _area_ that is affected by the change. +An area is usually the name of the affected crate without the `ruma-` prefix, +except for the ruma-common crate, where the area is usually the name of the +top-level module, like `api` or `identifiers`. For example, the description of +a commit that affects the ruma-events crate should look like +"events: Add new event". + Write commit messages using the imperative mood, as if completing the sentence: "If applied, this commit will \_\_\_." For example, use "Fix some bug" instead of "Fixed some bug" or "Add a feature" instead of "Added a feature".