CCSMB 4: Recommendations for Lua Code #16
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
EmmaKnijn
reviewed
Nov 22, 2022
Closed
|
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. |
|
tomodachi94
added
the
status: stale
dimaguy
reviewed
Apr 3, 2024
|
|
||
| **1.1.3.** Code intended for distribution MUST have a licence statement located near or at the top of the file. This can be any statement of licence, including "all rights reserved" or "public domain". The CCSMB RECOMMENDS using one of the following licence types: | ||
|
|
||
| * CC0 or Unlicense or Public Domain |
There was a problem hiding this comment.
I believe CC0 isn't recommended for code (isn't approved by OSI)
|
|
||
| **1.1.2.** Lua files SHOULD have the extension `.lua`, but older programs MAY accept no extension as well. | ||
|
|
||
| **1.1.3.** Code intended for distribution MUST have a licence statement located near or at the top of the file. This can be any statement of licence, including "all rights reserved" or "public domain". The CCSMB RECOMMENDS using one of the following licence types: |
There was a problem hiding this comment.
I recommend adding links to the licenses (or choosealicense.com) if this document doesn't go into their differences
| @@ -0,0 +1,122 @@ | |||
| # CCSMB 4: Recommendations for Lua Code | |||
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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