-
Fork the repo.
-
Run the tests. Pull requests will only be accepted when all tests pass, and it's great to know that everything is running correctly:
mvn test -
Add a test for your change. Only refactoring and documentation changes require no new tests. If you are adding functionality or fixing a bug, we need a test!
-
Make the test pass.
-
Push to your fork and submit a pull request.
At this point, you're waiting on me. I'm not working with Java much these days, so I may be slow to respond.
If it's your first time contributing, don't forget to add your details to the contributors section of our project file. (Specification here.)
Some things that will increase the chance that your pull request is accepted:
- Follow the Google code conventions
- Include tests that fail without your code, and pass with it
- Update the documentation, the surrounding one, examples elsewhere, guides, whatever is affected by your contribution
And in case I didn't emphasize it enough: I love tests!