Document code style standards.
This commit is contained in:
parent
a12d44c4f8
commit
c85ab6903d
12
CONTRIBUTING
12
CONTRIBUTING
@ -41,10 +41,14 @@ Other Guidelines:
|
||||
repo, but will not be packaged by ContentDB to keep download sizes
|
||||
minimal.
|
||||
|
||||
- Lua code indentation style is based on this script:
|
||||
http://notebook.kulchenko.com/programming/lua-beautifier-in-55-lines-of-perl
|
||||
(except with INDENT set to "\t" for tabs instead of spaces)
|
||||
This is very similar to the style used by ZeroBrane Studio.
|
||||
- Lua code formatting/style is using:
|
||||
https://gitlab.com/Warr1024/luatools
|
||||
Install the commands in your $PATH, and then in the root of the
|
||||
project, run this command to format the code:
|
||||
lualocals -f pkluaformat
|
||||
You can add a -c option to lualocals to make it check only but not
|
||||
modify your code; the check-only version is very useful in a git
|
||||
pre-commit hook script.
|
||||
|
||||
------------------------------------------------------------------------
|
||||
========================================================================
|
||||
|
@ -24,8 +24,6 @@ ISSUES: Bugs, Cleanup and Refinements
|
||||
- Can sanely attach ABMs to check for a supporting node, or
|
||||
periodic signalling to remain.
|
||||
|
||||
- Document code formatting tools and standards.
|
||||
|
||||
- Falling_node is a train-wreck and needs to be rebuilt.
|
||||
- Attempts to monkey-patch it have still left fundamental problems.
|
||||
- Falling nodes can sometimes end up occupying the same space and
|
||||
|
Loading…
x
Reference in New Issue
Block a user