Contributing

About this page

Valid as of	Completion
SleepFixer v2.0.0	🟢 100%

---

Musts:

• Before working on a PR, please contact the development team to make sure it is worthy of your time. If an issue on the issue tracker has the label contributions welcome then it is likely we will give you the 👍🏻.
• Do not use automatic code cleanup on your IDE. For example, Reformat Code and Rearrange Code on IntelliJ do this, it messes with my manual intentional arrangement of code and comments.
• Please use curly brackets, especially if it is an 'if abc else xyz' statement. The only exception is for small 'if' statements, such as if(enabled) runMethod();.
• Include javadocs and comments to your code wherever possible, unless it is obviously self-explanatory (e.g. 'changeWoolColor(Block)`)
• Please do not commit any personal IDE settings change unless you feel they are a significant improvement. If you find your IDE is adding its own files then consider adding them to .gitignore.
• Use American English (en-us) as the language in all of your contributions.

Ownership of Code:

• Any contributions must fall under the same license described in LICENSE.md.
• You are expected to own or clearly credit the code you have contributed.
• If you are copying code, check the license of copied code beforehand and request permission from the code's author.

Recommendations:

• Use JetBrains IntelliJ IDEA, it's far better than Eclipse and it's free.