From 7f67115485382ff50be75ff4ea25aa6c46fea171 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Henrique=20F=2E=20Sim=C3=B5es?= Date: Tue, 15 Nov 2022 15:48:51 -0300 Subject: [PATCH] docs: Fix markdown commit message block in CONTRIBUTING The code block for the commit message contains blank characters that are breaking the markdown rendering engine, making the message block to stop right after the first paragraph, and getting rid of the last line. Simply cleaning these blank characters make the code block to render properly. Note that I've also specified the type of the block, which is plain text. --- CONTRIBUTING.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 873f6d5a..403efa9f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,15 +11,17 @@ Please note we have a code of conduct, please follow it in all your interactions the pull request. 2. If you're adding new API, it must be properly documented. 3. The commit message is formatted as follows: - ``` + + ```plain 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.