CONTRIBUTING.md

If you want to contribute to GeyserUpdater, please ask in our Discord to find out which branch would be best to make changes to.

• To clone the repo, run git clone https://github.com/ProjectG-Plugins/GeyserUpdater.git in your command line or terminal.

• You can build locally and install dependencies using maven. Use mvn clean install to install all required dependencies and compile the jar. The built jar will be located in the target folder.

Please follow the guidelines below for any code you wish to contribute, we are always open for PRs!

public class LongClassName {

    private static final int CONSTANT = 0; // Constants should be capitalized

    public Int2IntMap items = new Int2IntOpenHashMap(); // Use the interface as the class type but initialize with the implementation.

    public int nameWithMultipleWords = 0;

    /**
    * Javadoc comment to explain what a function does.
    */
    @RandomAnnotation(stuff = true, moreStuff = "might exist")
    public void applyStuff() {
        Variable variable = new Variable();

        if (condition) {
	        // Do stuff.
        } else if (anotherCondition) {
	    	// Do something else.
        }

        switch (value) {
            case 0: // Intentional fallthrough
            case 1:
                stuff();
                break;
	    case 2:
	        differentStuff();
                break;
        }
    }
}

If you need help with code for this, you can go to our Discord. Please do not ping anyone without the "Pingable" role assigned!