Code Review Process

All contributions to the codebase - whether fork or pull request - will be reviewed per the below criteria. To increase your chances of your push being accepted please be aware of the following

• Write well formed commit messages
• Follow our style guide recommendations
• Write tests for all changes (additions or refactors of existing code).
• Of the github integrations we use two will be utilised to check appraise your contribution. In order of priority these are
  • Travis ensures that all tests (existing and additions) pass
  • Coveralls ensures that overall test coverage for lines of code meets a certain threshold. If this metric dips below what it previously was for the repository you’re pushing to then your PR will be rejected
  • (Gemnasium ensures dependencies are up to date, but this isn't likely to impact your PR)
• Once your PR is published and passes the above checks a repository administrator will review your contribution. Where appropriate comments may be provided and amendments suggested before your PR is merged into Master.
• Once your PR is accepted you will be granted push access to the repository you have contributed to! Congratulations on joining our community, you’ll no longer need to work from forks.

Push Access

If you make a contribution to another repository in the Toolbox you will be expected to repeat this process. This is necessary as there is variance across our toolboxes - from different web frameworks (e.g. Bothan [Sinatra] vs CSVlint, Octopub, Pathway and Certificates [Rails]) to different underlying code (Comma Chameleon built on Javascript via the Electron runtime)

Code Style Guide

We follow the same code style conventions as detailed in Github’s Ruby Style Guide