We welcome bug reports and pull requests from everyone! This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
There are two ways to contribute:
If you find a bug or think of a useful improvement, file an issue in this GitHub repository. Make sure to include details about what you think should be changed and why. If you're reporting a bug, please provide a minimum working example so that a maintainer can reproduce the bug.
If you know exactly what needs to change, you can also submit a pull request to propose the change.
- Fork it ( https://github.com/civisanalytics/civisml-extensions/fork ).
- Install the dependencies (
pip install -r requirements.txtandpip install -r dev-requirements.txt) - Make sure you are able to run the test suite locally (
pytest) - Create a feature branch (
git checkout -b my-new-feature) - Make your change. Don't forget tests
- Make sure the test suite, including your new tests, passes (
pytest && flake8) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new pull request
- If the Travis build fails, address any issues
- All pull requests must include test coverage. If you’re not sure how to test your changes, feel free to ask for help.
- Contributions must conform to PEP 8 and the NumPy/SciPy Documentation standards:
- Code in this repo should also conform to the scikit-learn standards. See their documentation for more information.
- Don’t forget to add your change to the CHANGELOG. See Keep a CHANGELOG for guidelines.
Thank you for taking the time to contribute!