From 7985055bc75d52a979b9de550ac60204308cf981 Mon Sep 17 00:00:00 2001 From: Thor Brigsted Date: Tue, 13 Feb 2018 11:06:03 +0100 Subject: [PATCH] Create CONTRIBUTING.md Read this before contributing --- CONTRIBUTING.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b96a660 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,23 @@ +## Contributing to xNode +đź’™Thank you for taking the time to contributeđź’™ + +If you haven't already, join our [Discord channel](https://discord.gg/qgPrHv4)! + +## Pull Requests +Try to keep your pull requests relevant, neat, and manageable. If you are adding multiple features, try splitting them into separate commits. +* Avoid including irellevant whitespace or formatting changes. +* Comment your code. +* Spell check your code / comments + +## New features +xNode aims to be simple and extendible, not trying to fix all of Unity's shortcomings. + +If your feature aims to cover something not related to editing nodes, it generally won't be accepted. If in doubt, ask on the Discord channel. + +## Coding conventions +Skim through the code and you'll get the hang of it quickly. +* Methods, Types and properties PascalCase +* Variables camelCase +* Public methods XML commented +* Open braces on same line as condition +* 4 spaces for indentation.