CCSMB 4: Recommendations for Lua Code

[MCJack123]

This RFC adds a proper standard for recommendations for Lua code, including programs and libraries. It's divided into two types of guidelines: interface guidelines, which are required to be compliant with the spec; and style guidelines, which are recommendations by the CCSMB but not required for full compliance. This supersedes #9 by adding much more detail to how Lua files should be written.

This is not complete at the moment, but I figured it would be good to add it for now to get more feedback and suggestions for things to add.

Closes #9

[piprett]

Very cool! Thanks.

[EmmaKnijn]

What about returning multiple values in the same statement, is that allowed?

[znepb]

This seems to be a great addition to CCSMB. However, I would like to propose to change the name of the standard to "Recommendations for Executable Lua Source," which would indicate that this RFC exclusively defines information for Lua packages and libraries, NOT Lua tables and/or byte code, which may become their own separate standard entirely.

[MCJack123]

1. Lua/"serialized" tables aren't really Lua code in theory - the fact that they are valid Lua code and loadable by load is an implementation detail (like how JSON is technically valid JavaScript code). As such, it's by default not covered under the "Lua code" title. Even so, serialized tables should still follow the style guidelines.
2. Bytecode is also not Lua, and is an implementation detail of the Lua VM, so it's also by default not covered as "Lua code".

[dimaguy]

I believe CC0 isn't recommended for code (isn't approved by OSI)

[dimaguy]

I recommend adding links to the licenses (or choosealicense.com) if this document doesn't go into their differences

[dimaguy]

CCSMB 4 should be italicized: CCSMB 4