CONTRIBUTING.md

CONTRIBUTING GUIDE LINES:

If you interested in contributing, please use standard lua (meaning no c style comments or operators) and space your code correctly. I should really write a guideline and will soon, but this is fine for now.

Formatting

• Delete trailing whitespace.
• Don't use C style comments //, /* */, use (-- and --[[ ]]--).
• Don't use C style operators !, !=, &&, ||, use not, ~=, and and or.
• Use apostrophe (') quotes.
• Add spaces before and after ...
• Don't include spaces after {, (, [ or before ], ), }.
• Don't misspell.
• Don't vertically align tokens on consecutive lines.
• Use 4 space indentation (no tabs).
• Use spaces after commas, after colons and semicolons, around { and before }.
• Use Unix-style line endings (\n).

Naming

• Avoid abbreviations.
• Avoid object types in names (user_array, email_method CalculatorClass, ReportModule).
• Use camel case for variables.
• Use upper camel case for functions.
• Use UPPERCASE for globals and constants.

Recommended editor is VS Code, with the following plugins:

• Bracket Pair Colorizer
• glua
• lua-luachecker
• Lua