From 713200773f980cf8aee2ba503a9a744b7b75615c Mon Sep 17 00:00:00 2001 From: Georges Basile Stavracas Neto Date: Thu, 14 Sep 2017 02:20:47 -0300 Subject: [PATCH] project: add example of commit message --- CONTRIBUTING.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6bd22c1f..65a9c3b5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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: + + A paragraph explaining the problem and its context. + + Another one explaining how you solved that. + + + ``` +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