Skip to content
This repository was archived by the owner on Dec 23, 2019. It is now read-only.

Guidelines for Contributing to Starfall

Robert edited this page Sep 19, 2013 · 2 revisions

If you plan to send a pull request to the Starfall repository, please follow these guidelines:

  • No GLua-specific syntax. eg,
    1. Don't use: !, use: not
    2. Don't use: &&, ||, !=, use these: and, or, ~=
    3. Don't use: //, /* */, use these: --, --
    4. Use tabs, not spaces.
  • Document your code, LuaDoc style. See the built-in libraries for some examples and some special formats that are supported (particularly with libraries)
  • Make sure you commit line endings as LF. See this github page for more info.
  • Use commits wisely. Try to make a commit for each new feature. Don't group tons of features into one commit, which makes cherry picking impossible. More commits are usually better then less.
  • Use camel case for methods and library functions. Ex. ents.doSomething()

Clone this wiki locally