-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
23 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |