Browse Source

Update Contributing;

bjorn 2 years ago
parent
commit
1e9f70181a
1 changed files with 12 additions and 13 deletions
  1. 12 13
      guides/Contributing.md

+ 12 - 13
guides/Contributing.md

@@ -3,21 +3,21 @@ Contributing
 
 
 You want to contribute to LÖVR?  That's awesome!
 You want to contribute to LÖVR?  That's awesome!
 
 
-Submitting Issues
+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.
+[GitHub issues](https://github.com/bjornbytes/lovr/issues) are used for reporting bugs and
+requesting new features or improvements.  Questions about using LÖVR should go in
+[Matrix](https://lovr.org/matrix) or [Discord](https://lovr.org/discord).
 
 
 Editing Documentation
 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).
+Documentation improvements are very much appreciated!  All of the documentation pages have a handy
+"Edit" button in the upper right which can be used to suggest changes.  These are submitted as pull
+requests to the [lovr-docs repo](https://github.com/bjornbytes/lovr-docs), which contains all the
+guides, examples, and API pages.  Documentation changes can also be suggested using a lovr-docs
+GitHub issue or in chat.
 
 
 Contributing Code
 Contributing Code
 ---
 ---
@@ -26,17 +26,16 @@ To contribute patches to the C code, you can fork LÖVR, commit to a branch, and
 request.  The target branch for the patch should be `master` for patch-level fixes, and `dev` for
 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
 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
 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:
+issues or Matrix/Discord before submitting.  Try to stick to the existing coding style:
 
 
 - 2 space indentation.
 - 2 space indentation.
 - 100 character wrapping (ish, sometimes it's more readable to just have a long line).
 - 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`.
 - Put stars near types: `Texture* texture`.
 - Use curly braces for the bodies of conditionals and loops, and place them on the same line.  An
 - 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.
   exception can be made for very short blocks -- they can be placed inline without curlies, e.g.
   `if (data == NULL) return;`.
   `if (data == NULL) return;`.
 - Always use spaces around binary operators.
 - Always use spaces around binary operators.
-- Always use spaces before the parentheses and curlies in control flow: `while (condition) {`.
+- Always use spaces around the condition in control flow: `while (condition) {`.
 
 
 Organization
 Organization
 ---
 ---
@@ -50,4 +49,4 @@ An overview of the folder structure:
 - `src/lib` contains smaller third party libraries.
 - `src/lib` contains smaller third party libraries.
 - `src/modules` has a folder for each module.
 - `src/modules` has a folder for each module.
 
 
-Branches other than master and dev may be force-pushed during development to keep commits clean.
+Branches other than master and dev may be force-pushed during development to keep history clean.