CONTRIBUTING.md

Contributing

Tell us your plans

Before contributing, let us know your plans - raise an issue.

Fork the repository

To contribute to this project you will need to create a fork of this repository.

Set up Goodtables.io validation

To run the validation tests each time you commit a change to your GitHub repository, you'll need to:

• login to Goodtables.io
• use Manage Sources to select your repository
• make a change to the data in a data package
• then check the results. (sample results)

Learn more about Goodtables.io

Make your changes

Contribute a data package

To add a data package:

• Follow the directory structure in the Readme
• Add your data package example
• Make sure the Goodtables.io tests pass
• Add a README.md using the template

Change a data package:

• Change the data package
• update the data package version. Follow the data package version pattern.
• Make sure the Goodtables.io tests pass

Submit a pull request

• Please be patient while volunteers review your pull request
• We may ask you to make changes to improve your contributions

Celebrate

You're now a contributor 🎉