From f2bc1eb6435273e21fb4522fa7372a8c65dc1923 Mon Sep 17 00:00:00 2001 From: Suraj Shetty <13928957+surajshetty3416@users.noreply.github.com> Date: Mon, 15 Jul 2019 17:03:10 +0530 Subject: [PATCH] Fix typo --- Naming-Guidelines.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Naming-Guidelines.md b/Naming-Guidelines.md index ea25963..f1893a1 100644 --- a/Naming-Guidelines.md +++ b/Naming-Guidelines.md @@ -3,7 +3,7 @@ Naming something is probably the most important decisions that you need to take ### General Guidelines 1. Naming should be something that is used in common language. There are legacy ERP systems that have a specific naming style, we should constantly keep away from those styles, going with a more simple naming style. Shopify is a great example of how to name things. For example, in legacy ERP systems, a Purchase Receipt is called as "Goods Receipt Note". -2. Names should represent the essence of the concepts they represent and avoid accounting / management jargon. +2. Names should represent the essence of the concepts they represent and avoid accounting/management jargon. 3. Names should be consistent with the rest of the system. 4. No abbreviations. Use complete names as far as possible in both object and variable naming. @@ -15,15 +15,15 @@ DocType names must be: 2. Singular 3. Names with multiple words should be separated by a space. Example "Sales Invoice" 4. US English -5. Child table names should be parent table names + the relation, for example "Sales Order Item" +5. Child table names should be parent table names + the relation, for example, "Sales Order Item" ### Field Naming 1. Labels must be Title Case 2. Link names must be same as the DocType they refer to (for example Link to "Employee" should be `employee`) -3. Table field names must plural and just be the relation, for example field name for "Sales Order Item" should be `items` +3. Table field names must be plural and just be the relation, for example, field name for "Sales Order Item" should be `items` 4. Field name must be the slugged version of the label ("First Name" must be `first_name`) -5. Avoid descriptions. Labels must be clear as possible. +5. Avoid descriptions. Labels must be as clear as possible. 6. Use full names (not abbreviations) ### Variable Naming