CONTRIBUTING.md

Etiquette Regarding Communication

When requesting support, try to remember that we are all volunteers that have lives outside of this project and none of us are paid to ensure things work for you, so please be considerate of others' time when you are asking for things. Many of us have families/friends/work/university that also need time as well and only have so much time to give on a daily basis. We will do what we can to provide support when folks are running into issues, but you may have to wait, so a little consideration and patience will be welcome. After all, you are using a pretty good tool without cost. It may not be perfect (yet), and we know that.

Adapted from choclatey

Defining a contribution

You are a contributor if you...

• have made at least one pull request which has been accepted
• are/were a member of the github organization

General

• Follow styling sheet (to be made)
• Comment your code in a way that LDoc can use (see below)
• Try to keep commits descriptive (I will admit that I don't always do this)
• Do lots of small commits over one big one, it's easier for others to contribute with you and easier to revert parts
• Pull requests: if it's all related then it can all go together, just make sure it's not all one big commit (see above) I can revert parts I don't like later. As to deciding what's related, use your best judgment.
• Don't edit files which your team is not responsible for, If you are not sure then check here the team description will help you. if you are still confused then just ask, either on the forums or make an issue.
• This project is under the MIT License. Any code contributions you make must be made under a compatible license.

Documentation Generation

Start here for basic syntax

• LDoc, a Lua Documentation Tool

Additional syntax examples

• http://stevedonovan.github.io/ldoc/examples/three.lua.html
• http://stevedonovan.github.io/ldoc/examples/four.lua.html
• http://stevedonovan.github.io/ldoc/examples/colon.lua.html
• http://stevedonovan.github.io/ldoc/examples/multiple.lua.html
• http://www.computercraft.info/forums2/index.php?/topic/21254-howl-lua-build-system/page__view__findpost__p__244826

Some notes:

• Hive - a turtle control system (ComputerCraft Forums)
• Howl - Lua build system (ComputerCraft Forums)
• Howl - multiple files vs single combined file distribution