From f56dd0e75e656c6f0e05883ae3ad3bc62d2190bf Mon Sep 17 00:00:00 2001 From: Rushabh Mehta Date: Mon, 8 Oct 2018 10:59:04 +0530 Subject: [PATCH] Updated Coding Standards (markdown) --- Coding-Standards.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/Coding-Standards.md b/Coding-Standards.md index 43b159f..9576fc1 100644 --- a/Coding-Standards.md +++ b/Coding-Standards.md @@ -69,4 +69,10 @@ If you are implementing business logic like calculations, or setting a value bas ### Commit Messages -Commit messages must follow the conventional commit specifications (https://www.conventionalcommits.org/en/v1.0.0-beta.2/) \ No newline at end of file +Commit messages must follow the conventional commit specifications (https://www.conventionalcommits.org/en/v1.0.0-beta.2/) + +### Code Comments + +While we believe that code should be written in a self explanatory way, comments will go a long way in expressing "why" the code is written in a particular manner. + +We don't expect heavily commented code, but some explanation of what a method does is required. [Read this post](http://antirez.com/news/124) on why code commenting is important. \ No newline at end of file