diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0821d8e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# 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](https://gradle.org/) 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: + +```shell script +./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](https://semver.org/) and does NOT prefix tags or release titles with `v` i.e. use `1.2.3` instead of `v1.2.3` diff --git a/README.md b/README.md index 36d1e82..4d9a606 100644 --- a/README.md +++ b/README.md @@ -58,10 +58,22 @@ making this ideal for developing new templates for your application. The template and data directory structure both follow the `/