Skip to content

Commit

Permalink
Added in CONTRIBUTING.md file
Browse files Browse the repository at this point in the history
  • Loading branch information
MikAoJk authored Aug 29, 2023
1 parent d7dfd2d commit 34def63
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# 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:

``` bash
./gradlew clean build
```

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.

0 comments on commit 34def63

Please sign in to comment.