mirror of
https://github.com/Siccity/xNode.git
synced 2026-02-16 20:11:51 +08:00
Create CONTRIBUTING.md
Read this before contributing
This commit is contained in:
parent
2a951a3002
commit
7985055bc7
23
CONTRIBUTING.md
Normal file
23
CONTRIBUTING.md
Normal file
@ -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.
|
||||||
Loading…
x
Reference in New Issue
Block a user