Skip to content

Latest commit

 

History

History
18 lines (12 loc) · 979 Bytes

CONTRIBUTING.md

File metadata and controls

18 lines (12 loc) · 979 Bytes

How to contribute

I'm really glad you're reading this, because we need volunteer developers to help this project come to fruition.

If you haven't already, check out the current issues to see what we are working on and join in on the fun.

Testing

We are targeting a robust test coverage for the code, please write tests for new code you create.

Submitting changes

Please create a GitHub Pull Request with a clear list of what you've done. We can always use more test coverage. Please follow our coding conventions (below) and make sure all of your commits are atomic (one feature per commit).

Always write a clear log message for your commits. Feel free to tag @henrygeorgist for a review.

Coding conventions

  • Please consider the other people contributing to the code - make it readable and reusable.
  • Please add comments to explain assumptions and limitations of the code
  • Please add comments to describe appropriate use of public members.