From c234734ab241aa702ec9525085c7c3569f840670 Mon Sep 17 00:00:00 2001 From: Artem Zakharchenko Date: Mon, 10 Dec 2018 10:14:57 +0100 Subject: [PATCH] Update README.md --- README.md | 27 ++++++++++++++++++++------- 1 file changed, 20 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index b7179be..7929aa0 100644 --- a/README.md +++ b/README.md @@ -29,9 +29,9 @@ const should_update = true ## S-I-D A name must be *short*, *intuitive* and *descriptive*: - * **Short**. A name must not take long to type and, therefore, to remember, - * **Intuitive**. Name must read naturally, as close to the common speach as possible - * **Descriptive**. Name must reflect what it does/possesses in the most efficient way, + * **Short**. A name must not take long to type and, therefore, to remember; + * **Intuitive**. Name must read naturally, as close to the common speach as possible; + * **Descriptive**. Name must reflect what it does/possesses in the most efficient way. ```js /* Bad */ @@ -47,7 +47,7 @@ const shouldDisplayPagination = (postsCount > 10) // alternatively ## Avoid contractions -Do **not** use contractions. They contribute to nothing but decreased readability of your code. Finding a short, descriptive name may be hard, but contraction is not an excude to not doing so. +Do **not** use contractions. They contribute to nothing but decreased readability of the code. Finding a short, descriptive name may be hard, but contraction is not an excuse for not doing so. ```js /* Bad */ @@ -90,22 +90,23 @@ return