maciek/TechReborn
maciek/TechReborn
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added contributing checklist.

Browse source
This commit is contained in:
drcrazy 2018-06-07 17:22:39 +03:00
parent 23428d3223
commit 76735d93bd
1 changed files with 19 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
.github/CONTRIBUTING.md vendored Normal file
View file

@ -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.