👍🎉 First off, thanks for taking the time to contribute! 🎉👍
This project and everyone participating in it is governed by our Code of Conduct. By participating you are expected to uphold this code.
This does not apply just yet, as the project is not in a production ready state at the moment, but will apply when the first stable release has been released.
The master branch should always be in a runnable and stable state, and should only be written to when there's a new release, or when a fix for a major bug has to be released.
Development should be done in the develop branch, this branch should - just like master - be in a runnable state at all times.
We use the K&R bracket style in this project. Also bracket-less if statements should be used wherever applicable.
Example:
public static void main(String[] args) {
int x = 3;
if (x == 3) {
System.out.println("x is 3");
} else {
System.out.println("x is not 3");
}
// Example of the mentioned 'bracket-less if statements'
if (true)
return;
// Please add a 'TODO' with your identifier whenever you do not finish anything, or when you sense it could be improved later on
// Example: TODO:sjg add more style examples
// In the above example, the 'sjg' is my (stanjg's) personal identiefier, choose your own.
}Issues/Bug Reports: Github Issues Suggestions/Feature Requests: Github Issues Security Matters: Discord (Stan#8888)