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.

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

Improve code consistency #4

Open
viral32111 opened this issue Apr 2, 2020 · 0 comments
Open

Improve code consistency #4

viral32111 opened this issue Apr 2, 2020 · 0 comments
Assignees
Labels
Enhancement An idea for a new feature or a modification to an existing feature. Help Wanted Extra assistance is required for solving this. Low Priority This issue isn't of much importance.
Milestone

Comments

@viral32111
Copy link
Owner

viral32111 commented Apr 2, 2020

Proposed changes

  • Rewrite all files to use correct code formatting rules, as listed below (rules are subject to change before being officially implemented).

Code formatting rules

  1. Use spaces after commas when defining/passing function arguments.
  2. Use spaces after commas when defining table items.
  3. Never terminate a line with a semi-colon.
  4. Use Lua comments (-- & --[[ ]]) instead of C-style comments (//, /* */).
  5. Use Lua operators (or, and, not, ~=) instead of C-style operators (||, &&, !, !=).
  6. Use brief comments where appropriate to describe what's happening (do not over-use comments).
  7. Use tabs at size 4 to indent, not spaces.
  8. Use new lines when defining each item in a table.
  9. Try to use strict checking for if statement expressions (i.e. use if ( whatever == true ) then rather than if ( whatever ) then).
@viral32111 viral32111 added the Enhancement An idea for a new feature or a modification to an existing feature. label Apr 2, 2020
@viral32111 viral32111 added Low Priority This issue isn't of much importance. Help Wanted Extra assistance is required for solving this. labels Apr 2, 2020
@viral32111 viral32111 added this to the Code Cleanup milestone Apr 8, 2020
@viral32111 viral32111 self-assigned this Apr 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement An idea for a new feature or a modification to an existing feature. Help Wanted Extra assistance is required for solving this. Low Priority This issue isn't of much importance.
Projects
None yet
Development

No branches or pull requests

1 participant