From d39fc81bb8c6220d9df638fa4f7f6f6b08908126 Mon Sep 17 00:00:00 2001 From: mrkubax10 Date: Sun, 5 Mar 2023 08:57:11 +0000 Subject: [PATCH] Create CODING_STYLE.md --- CODING_STYLE.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 CODING_STYLE.md diff --git a/CODING_STYLE.md b/CODING_STYLE.md new file mode 100644 index 0000000..f0f07dd --- /dev/null +++ b/CODING_STYLE.md @@ -0,0 +1,30 @@ +# IndustrialTest coding style guidelines +## Indenting +You should use tabs for indentation. + +## Naming convention +Use `lowerCamelCase` for functions, variables and table keys. Use `UPPER_SNAKE_CASE` for constants and `lower_snake_case` for filenames. + +## Other +If table contains one element then it can be inlined: +```lua +someTable={element} +``` +or: +``` +someTable={key=element} +``` +however if it contains more than one element then each element should go on separate line: +```lua +someTable={ + element1, + element2 +} +``` +or: +```lua +someTable={ + key=element1, + key2=element2 +} +``` \ No newline at end of file