UnityMirror/xNode
1
0
Fork 0
mirror of https://github.com/Siccity/xNode.git synced 2026-02-07 07:44:53 +08:00
Code

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Thor Brigsted 2019-06-17 09:26:35 +02:00 committed by GitHub
parent 53bba68ae0
commit 369a3fd6ea
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
CONTRIBUTING.md
View File

@ -4,10 +4,11 @@
If you haven't already, join our [Discord channel](https://discord.gg/qgPrHv4)! If you haven't already, join our [Discord channel](https://discord.gg/qgPrHv4)!
## Pull Requests ## Pull Requests
Try to keep your pull requests relevant, neat, and manageable. If you are adding multiple features, try splitting them into separate commits. Try to keep your pull requests relevant, neat, and manageable. If you are adding multiple features, split them into separate PRs.
* Avoid including irellevant whitespace or formatting changes. * Avoid including irellevant whitespace or formatting changes.
* Comment your code. * Comment your code.
* Spell check your code / comments * Spell check your code / comments
* Use consistent formatting
## New features ## New features
xNode aims to be simple and extendible, not trying to fix all of Unity's shortcomings. xNode aims to be simple and extendible, not trying to fix all of Unity's shortcomings.
@ -15,7 +16,7 @@ xNode aims to be simple and extendible, not trying to fix all of Unity's shortco
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. 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 ## Coding conventions
Skim through the code and you'll get the hang of it quickly. Using consistent formatting is key to having a clean git history. Skim through the code and you'll get the hang of it quickly.
* Methods, Types and properties PascalCase * Methods, Types and properties PascalCase
* Variables camelCase * Variables camelCase
* Public methods XML commented. Params described if not obvious * Public methods XML commented. Params described if not obvious