diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 33da9d3..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,32 +0,0 @@ -## 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, split them into separate PRs. -* Avoid including irellevant whitespace or formatting changes. -* Comment your code. -* Spell check your code / comments -* Use consistent formatting - -## 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 -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 -* Variables camelCase -* Public methods XML commented. Params described if not obvious -* Explicit usage of brackets when doing multiple math operations on the same line - -## Formatting -I use VSCode with the C# FixFormat extension and the following setting overrides: -```json -"csharpfixformat.style.spaces.beforeParenthesis": false, -"csharpfixformat.style.indent.regionIgnored": true -``` -* Open braces on same line as condition -* 4 spaces for indentation.