Explorar o código

Add Contributing guide;

bjorn %!s(int64=5) %!d(string=hai) anos
pai
achega
72e96560b6
Modificáronse 2 ficheiros con 50 adicións e 0 borrados
  1. 49 0
      guides/Contributing.md
  2. 1 0
      guides/init.lua

+ 49 - 0
guides/Contributing.md

@@ -0,0 +1,49 @@
+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](https://lovr.org/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](https://github.com/bjornbytes/lovr-docs).
+
+Contributing Code
+---
+
+To contribute patches to the C code, you can fork LÖVR, commit to a branch, and submit a pull
+request.  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.
+
+Organization
+---
+
+An overview of the folder structure:
+
+- `deps` contains submodules for external dependencies.  Some smaller dependencies are also included
+in the `src/lib` folder.
+- `src/api` contains Lua bindings.  There's a file for each module and a file for each 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 in the project.  It's good to keep them separated as
+  much as possible, there's inevitably some overlap.
+- `src/resources` is a sort of "junk drawer" containing helper files like shaders, icons, scripts,
+  etc. often included in builds for various platforms.
+
+Branches other than master can be force-pushed during development to organize commit history.

+ 1 - 0
guides/init.lua

@@ -5,6 +5,7 @@ return {
   'Vectors',
   'Libraries',
   'Distribution',
+  'Contributing',
   'Compiling',
   'FAQ'
 }