Skip to content
This repository has been archived by the owner on Jul 3, 2024. It is now read-only.

Commit

Permalink
Created CONTRIBUTING.md (#207)
Browse files Browse the repository at this point in the history
  • Loading branch information
MikAoJk authored Mar 19, 2024
1 parent 400a603 commit 9929718
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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 maven 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
./mvnw clean install
```

This will run all the steps defined in the `pom.xml` 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`

0 comments on commit 9929718

Please sign in to comment.