We'd love to get contributions from you!
If you have any questions or run into any problems, please create an issue
The supported workflow for contributing is as follows:
- Fork the repo
- Make a feature or bugfix branch (use
git checkout -b "your-feature-or-fix") - Make your cool new feature or bugfix on your branch
- Include tests for your change
- From your branch, make a pull request
- The maintainers will review your change
- Once your change has been reviewed and accepted, wait for your change to be merged into
master - Delete your feature branch
We use FindBugs, which uses static analysis to look for bugs in Java code, to catch common bugs and we generally follow a style guide similar to the Google Java Style Guide with exception on indentation (we use 4 spaces)
When creating an issue please explain the steps to reproduce the issue or include a code snippet to illustrate the issue in more detail. The maintainers will review all issues created and we'll do our best to give feedback if necessary. However, we recommend that you send a Pull Request with a fix if you can manage - contributions are always welcome
As outlined above, you must create a feature or bugfix branch and make a pull request from the branch which the maintainers will review. You may be asked to improve some things in the pull request and once the pull request is satisfactory it will be merged into the mainline.
Please see the following post on writing good commit messages
The repository on GitHub is kept in sync with an internal repository at Credit Data CRB Ltd. For the most part this process should be transparent but it may have some implications on how pull requests are merged in.
When you submit a pull request on GitHub, it will be reviewed inside (and possibly outside of) Credit Data CRB Ltd, and once the changes are approved, your commits will be brought into the internal system for additional testing. Once the changes are merged internally, they will be pushed back to GitHub.