An optional block comment talking about why this file exists.Be consistent with idiomatic Lua when appropriate.įiles should consist of these things (if present) in order:.

Metatables are a good example of a powerful feature that should be used with care.

Then no one knows why it broke or how to fix it.

Magical code is really nice to use, until something goes wrong.

Avoid magic, such as surprising or dangerous Lua features:.

Clean diffs make it easier to get your code reviewed. It's much easier to read a diff that doesn't involve moving things between lines.

All else being equal, consider what the diffs might look like.

Many people will need to read it, from the reviewers, to any one else that touches the code, to you when you come back to it in six months.

Optimize code for reading, not writing.

There's no one right answer to how to format code, but consistency is important, so we agree to accept this one, somewhat arbitrary standard so we can spend more time writing code and less time arguing about formatting details in the review.The purpose of a style guide is to avoid arguments.Although Lua is a significantly different language, the guide's principles still hold. This guide is designed after Google's C++ Style Guide. This style guide aims to unify as much Lua code at Roblox as possible under the same style and conventions.

Roblox coding