From 586b02dd4a0f18c2274dbfd42411375a70b3b8cb Mon Sep 17 00:00:00 2001 From: Anish Umale Date: Wed, 5 Jun 2024 16:07:47 +0530 Subject: [PATCH 1/2] add identifier teminology spec for backend --- docs/engineering/code-review/backend.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/engineering/code-review/backend.md b/docs/engineering/code-review/backend.md index 54548dc00..af7ae9160 100644 --- a/docs/engineering/code-review/backend.md +++ b/docs/engineering/code-review/backend.md @@ -17,7 +17,11 @@ Linting should handle many style issues, but here's some to check manually: 1. Imports should be ordered in alphabetical order, with standard library imports first, third-party imports second, and local imports third. 1. All class attributes should be defined _before_ class methods. 1. Internal functions (not meant to be used outside the class or file) should be prefixed with an underscore (`_`). -1. Variable names should _not_ be reused within the same function. +1. Variable names should _not_ be reused within the same function +1. Identifier terminology (for the service layer): + - All the database object identifiers should be named with database object followed by `_oid` e.g. `database_oid`, `schema_oid` and `table_oid`. + - Columns should be identified by `attnum`. + - The django model identifiers should be named with model name followed by `_id`, e.g. `database_id`, `user_id`, `server_id`. ## Testing 1. There should be tests for new functionality. From c3104be7a66e71c869ae32bbf8780793e77dd35f Mon Sep 17 00:00:00 2001 From: Anish Umale Date: Wed, 5 Jun 2024 16:09:17 +0530 Subject: [PATCH 2/2] restore . --- docs/engineering/code-review/backend.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/engineering/code-review/backend.md b/docs/engineering/code-review/backend.md index af7ae9160..b53322874 100644 --- a/docs/engineering/code-review/backend.md +++ b/docs/engineering/code-review/backend.md @@ -17,7 +17,7 @@ Linting should handle many style issues, but here's some to check manually: 1. Imports should be ordered in alphabetical order, with standard library imports first, third-party imports second, and local imports third. 1. All class attributes should be defined _before_ class methods. 1. Internal functions (not meant to be used outside the class or file) should be prefixed with an underscore (`_`). -1. Variable names should _not_ be reused within the same function +1. Variable names should _not_ be reused within the same function. 1. Identifier terminology (for the service layer): - All the database object identifiers should be named with database object followed by `_oid` e.g. `database_oid`, `schema_oid` and `table_oid`. - Columns should be identified by `attnum`.