diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8638230..33da9d3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,10 +4,11 @@ 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. +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. @@ -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. ## 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 * Variables camelCase * Public methods XML commented. Params described if not obvious