lovr-docs/guides/Contributing.md

Contributing

You want to contribute to LÖVR? That's awesome!

Submitting Issues

Feel free to file an issue if you notice a bug. Make sure you search before filing an issue, as it may have already been asked.

Issues are okay for feature requests and questions about the development of LÖVR as well, but usually you'll get a better response by asking in Slack. Questions about how to use LÖVR should go in Slack.

Editing Documentation

If you notice any typos or inconsistencies in the docs, speak up! You can mention it in Slack, or if you're feeling brave you can submit a pull request in the lovr-docs repo.

Contributing Code

To contribute patches to the C code, you can fork LÖVR, commit to a branch, and submit a pull request. The target branch for the patch should be master for patch-level fixes, and dev for new functionality or API changes. Note that contributions to the repository will be released under the terms in the LICENSE. For larger changes, it is a good idea to engage in initial discussion via issues or Slack before submitting. Try to stick to the existing coding style:

• 2 space indentation.
• 100 character wrapping (ish, sometimes it's more readable to just have a long line).
• Use descriptive, camelCased variable names when possible.
• Put stars near types: Texture* texture.
• Use curly braces for the bodies of conditionals and loops, and place them on the same line. An exception can be made for very short blocks -- they can be placed inline without curlies, e.g. if (data == NULL) return;.
• Always use spaces around binary operators.
• Always use spaces before the parentheses and curlies in control flow: while (condition) {.

Organization

An overview of the folder structure:

• deps contains submodules for external dependencies.
• etc is a sort of "junk drawer" containing shaders, icons, scripts, etc.
• src/api contains Lua bindings. There's a file for each module and object.
• src/core contains shared engine code. It's usually lower-level and not specific to LÖVR.
• src/lib contains smaller third party libraries.
• src/modules has a folder for each module.

Branches other than master and dev may be force-pushed during development to keep commits clean.