Naming Conventions as per Code Style to Be Observed#
The latest style guide document is to be found via the following link: https://dataproducts.data.novonordisk.cloud/team/style_guide/#21-quotati
Python Naming#
See below list for python naming conventions:
* module_name,
* package_name,
* ClassName,
* method_name,
* ExceptionName,
* function_name,
* GLOBAL_CONSTANT_NAME,
* global_var_name,
* instance_var_name,
* function_parameter_name,
* local_var_name
Environment Variables#
Environment variables are capitalized.
❌ NO
my_env_var = os.getenv('my_env_var')
✔️ YES
MY_ENV_VAR = os.getenv('MY_ENV_VAR')
CloudFormation Names#
CloudFormation names of resources are written in PascalCase. The corresponding typescript variable should be named the same in camelCase.
❌ NO
const myS3Bucket = new s3.Bucket(this, "my_s3_bucket", { ...});
✔️ YES
const myS3Bucket = new s3.Bucket(this, "MyS3Bucket", { ...});
Resource Names#
AWS infrastructure is named in kebab-case.
❌ NO
const myS3Bucket = new s3.Bucket(this, "MyS3Bucket", { bucketName: MyS3Bucket,});
✔️ YES
const myS3Bucket = new s3.Bucket(this, "MyS3Bucket", { bucketName: my-s3-bucket,});