CwCommons Library

Library for commonly used code in Crimson Warpedcraft plugins.

Contributing

General workflow

1. First, pull any changes from main to make sure you're up-to-date
2. Create a branch from main
   • Give your branch a name that describes your change (e.g. add-scoreboard)
   • Focus on one change per branch
   • Keep your commits small, and write descriptive commit messages
3. When you're ready, create a pull request to main with a descriptive title, and listing any changes made in its description
   • Link any issues that your pull request is related to as well

Example:

Create scoreboard for total points

ADDED - Scoreboard displayed in-game at game end  
CHANGED - Updated `StorageManager` class to persist scoreboard data

After the pull request has been reviewed, approved, and passes all automated checks, it will be merged into main.

Building locally

Thanks to Gradle, building locally is easy no matter what platform you're on. Simply run the following command:

macOS/Linux/Unix/

./gradlew build

Windows

gradlew.bat build

This build step will also run all checks, making sure your code is clean.