Skip to content

Latest commit

 

History

History
25 lines (16 loc) · 1.02 KB

CONTRIBUTING.md

File metadata and controls

25 lines (16 loc) · 1.02 KB

Contributing

This project is open to accept feature requests and contributions from the open source community. Please fork the repo and start a new branch to work on.

Building locally

This project is using Gradle for its build tool. A Gradle Wrapper is included in the code though so you do not have to manage your own installation.

To run a build simply exucute the following:

./gradlew shadowJar

This will run all the steps defined in the build.gradle.kts file.

Testing

If you are adding a new feature or bug fix please ensure there is proper test coverage.

Pull Request Review

If you have a branch on your fork that is ready to be merged, please create a new pull request. The maintainers will review to make sure the above guidelines have been followed and if the changes are helpful to all library users, they will be merged.

This project uses semantic versioning and does NOT prefix tags or release titles with v i.e. use 1.2.3 instead of v1.2.3