chris/ruwuma
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Document area prefix for commits

Browse Source
This commit is contained in:
Kévin Commaille 2024-06-10 21:19:38 +02:00 committed by Kévin Commaille
parent a397f0a327
commit 99b30fb9d4
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
CONTRIBUTING.md
View File

@ -137,6 +137,13 @@ use super::MyType;
### Commit Messages ### 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: Write commit messages using the imperative mood, as if completing the sentence:
"If applied, this commit will \_\_\_." For example, use "Fix some bug" instead "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". of "Fixed some bug" or "Add a feature" instead of "Added a feature".