From 76735d93bd508573f7c21ade84988ed84d3346eb Mon Sep 17 00:00:00 2001 From: drcrazy Date: Thu, 7 Jun 2018 17:22:39 +0300 Subject: [PATCH] Added contributing checklist. --- .github/CONTRIBUTING.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 .github/CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 000000000..3d46aa4f0 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,19 @@ +First of all, thank you for you efforts in contributing to TechReborn project + +In order to ease code review of your pull request, please, go through this checklist. + + * The code compiles )). + * The code has been developer-tested. + * The code includes javadoc where appropriate. + * The code is tidy (indentation, line length, no commented-out code, no spelling mistakes, etc). + * Proper use of exceptions has been considered. It is fine to throw an exception during init. + * Proper side usage (client vs server) + * Logging is used appropriately. Please, do not spam log files + * Unused imports are eliminated. + * Warnings produced by the IDE are eliminated. + * Are there any leftover stubs or test routines in the code? + * Are there any hardcoded, development only things still in the code? + * Was performance considered? + * Corner cases well documented or any workarounds for a known limitation of the MC, Forge, RC, etc used. + +