Skip to content

Latest commit

 

History

History
27 lines (21 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

27 lines (21 loc) · 1.19 KB
Raw

How to contribute

Make a suggestion

  1. Create an issue with your suggestion
  2. I will respond within a few days, unless I'm on holiday

Submit changes

  1. Create a pull request (read more about pull requests)
  2. I will respond within a few days, unless I'm on holiday
  3. We merge the pull request or agree on another solution

Data changes

  1. Change the CSV files in data/
  2. Raise a pull request as above
  3. After the pull request is merged, I'll publish the changes so they get reflected in the API (this is not automated)

Code of conduct

Please be nice on the internet. Not being nice may result in issues or PRs being closed.

Coding conventions

  • There are no strict conventions
  • When in doubt, follow the ruby style guide
  • When changing existing code, create separate commits for any style changes, so it's easier to review the functional changes

Testing

  • There are no tests of the code
  • If you want to write some, please go ahead!