From cf8f0b71a10a8f974856a3f341e7ce7b0cdf949f Mon Sep 17 00:00:00 2001 From: Debjeet Biswas Date: Tue, 26 Sep 2023 19:55:18 +0530 Subject: [PATCH] docs: update contribution guide (#53) * docs: update contribution guide - add relevant information around exceeding `body-max-line-length` - add relevant good & bad commit examples closes #50 --- .github/CONTRIBUTING.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 50aa3a9ed..d398530dd 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -42,7 +42,8 @@ All commits landing in any branch are first linted in your local environment and - **android** for commits related to Android SDK - **webapp** for commits related to dashboard web app - **backend** for commits related to backend infrastructure -- Try not to exceed exceed **72** characters for commit header message +- Try not to exceed **72** characters for commit header message +- Try not to exceed **100** characters for each line in body. Break each line with newlines to remain under 100 characters. - Make sure commit message headers are in lowercase - Make sure commit message body & footer are always sandwiched with a single blank line @@ -67,6 +68,14 @@ All commits landing in any branch are first linted in your local environment and Add android symbolication of unhandled exceptions ``` +- Exceeding `body-max-line-length` + + ``` + fix(backend): frames not ingesting + + this is a really really really long line that is exceeding the allowed limit of max characters per line + ``` + ### ✅ Good Commits - Correct `type` @@ -87,4 +96,13 @@ All commits landing in any branch are first linted in your local environment and feat(backend): add exception symbolication Add android symbolication of unhandled exceptions + ``` + +- Each body line is within limits + + ``` + fix(backend): frames not ingesting + + this is a really really really long line that is + exceeding the allowed limit of max characters per line ``` \ No newline at end of file