Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add identifier teminology spec for backend #116

Merged
merged 2 commits into from
Jun 20, 2024
+4 −0
Merged

Add identifier teminology spec for backend #116

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
586b02d
add identifier teminology spec for backend
Anish9901 Jun 5, 2024
c3104be
restore .
Anish9901 Jun 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/engineering/code-review/backend.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ Linting should handle many style issues, but here's some to check manually:
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. 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.
Expand Down
Loading