We welcome contributions and suggestions to help us improve this project. If you are unfamiliar with Github, here is their official guide to start contributing to open source projects.
- Fork this repository
- Create a branch
git checkout -b my-branch - Stage and commit your changes
git commit -am 'description of my changes’ - Push the changes to your fork
git push origin my-branch - Submit a pull request to the parent repo. Please read our guide to submitting pull requests to see what we expect in a good pull request message.
- Pull request should be assigned to:
- @ejfox (primary)
- @geraldarthur
- @enjalot
Additionally, you can create issues on this repo to suggest changes or improvements. If you believe there’s a bug, we encourage you to use best practices, and please tell us the following:
- Describe your computer and the file (e.g. What’s your operating system? How big is your dataset?)
- Describe what you were doing (e.g. Running tests? Which test are you running?)
- Describe what you expected to happen (e.g. Did you expect a particular test to fail?)
- Describe what actually happened (e.g. Did the test in question pass or cause Dataproofer to break?)
And of course you can always email us: [email protected].
- Follow our code styleguide (coming soon) and use our linter configuration file with your preferred text editor
- Follow our Code of Conduct.
- Use markdown syntax for all text documents.