Skip to main content

Contributing

If you believe a feature is missing, or have an idea for how to improve the API, then by all means contribute! Make sure to follow clean-code styles. I closely follow the principles set forth in books such as Effective Java by Joshua Bloch, Clean Code, and The Clean Coder by Robert Cecil Martin.

Some good general guidelines to keep in mind:

  • Make sure your implementation closely matches the implementation you see present (follow the same code style)
  • Make sure to add Javadoc to every member, field, class, method, etc.
  • Make sure to write unit tests, if applicable, for your code and update any tests which might be failing due to a change you made
  • Make sure all unit tests are passing before you submit a PR
  • Make sure that code coverage is maintained at 100% (or reasonably high) before you submit a PR

Issues​

Don't worry about following a specific issue format, just check that your issue doesn't already exist before creating it. If you're submitting a PR to fix something, make sure there's an issue to reference (create one if needed and assign it to yourself).