project: add example of commit message
This commit is contained in:
+11
-1
@@ -9,7 +9,17 @@ Please note we have a code of conduct, please follow it in all your interactions
|
|||||||
|
|
||||||
1. Ensure your code compiles. Run `make` before creating the pull request.
|
1. Ensure your code compiles. Run `make` before creating the pull request.
|
||||||
2. If you're adding new API, it must be properly documented.
|
2. If you're adding new API, it must be properly documented.
|
||||||
3. You may merge the pull request in once you have the sign-off of the maintainers, or if you
|
3. The commit message is formatted as follows:
|
||||||
|
```
|
||||||
|
component: <summary>
|
||||||
|
|
||||||
|
A paragraph explaining the problem and its context.
|
||||||
|
|
||||||
|
Another one explaining how you solved that.
|
||||||
|
|
||||||
|
<link to the bug ticket>
|
||||||
|
```
|
||||||
|
4. You may merge the pull request in once you have the sign-off of the maintainers, or if you
|
||||||
do not have permission to do that, you may request the second reviewer to merge it for you.
|
do not have permission to do that, you may request the second reviewer to merge it for you.
|
||||||
|
|
||||||
## Code of Conduct
|
## Code of Conduct
|
||||||
|
|||||||
Reference in New Issue
Block a user