diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..34c84ba --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,24 @@ +# Contributing + +We love pull requests from everyone. Please be nice and forgive us +if we can't process your request right away. + +Fork, then clone the repo: + + git clone git@github.com:your-username/Jabit.git + +Make sure the tests pass: + + ./gradlew test + +Make your change. Add tests for your change. Make the tests pass: + + ./gradlew test + +Push to your fork and [submit a pull request][pr]. + +[pr]: https://github.com/Dissem/Jabit/compare/ + +Unfortunately we can't always answer right away, so we ask you to have +some patience. Then we may suggest some changes or improvements or +alternatives.