Skip to content

Commit 0e64cd8

Browse files
Grolleau-BenjaminGrom-
authored andcommitted
[doc] complete CONTRIBUTING guideline
1 parent 26128ca commit 0e64cd8

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,17 @@ Please note that:
3838
## 3. Support requests and questions
3939

4040
For support requests or any other question related to the product, the tools, the environment, you can submit a post to the **ST Community** on the appropriate topic [page](https://community.st.com/s/topiccatalog).
41+
42+
---
43+
44+
### 4. Commit message guidelines
45+
46+
To help maintain a clear history, please format your commit messages using the following convention:
47+
48+
```
49+
[scope] short summary
50+
```
51+
52+
- **Scope**: one of the directories or areas affected (e.g. `api/certificate`, `doc`, `git`, `Admin`).
53+
- **Short summary**: present tense, no trailing period, under 72 characters, starting with a lowercase verb; if related to an opened issue, append `#<number>`
54+
- **Body**: if necessary, or when the summary exceeds 72 characters, provide additional details explaining the motivation and how this change differs from previous behavior.

0 commit comments

Comments
 (0)