project: add example of commit message

2017-09-14 13:26:28 -03:00
parent a853376629
commit 713200773f
1 changed files with 11 additions and 1 deletions
@@ -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.
 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.

 ## Code of Conduct