Skip to content

Latest commit

 

History

History
21 lines (17 loc) · 899 Bytes

CONTRIBUTING.md

File metadata and controls

21 lines (17 loc) · 899 Bytes

Contributing guidelines

Before contributing

Welcome to kedro-init! Before contributing to the project, make sure that you read our code of conduct (CODE_OF_CONDUCT.md).

Contributing code

  1. Set up a Python development environment (advice: use venv, virtualenv, or miniconda)
  2. Install tox: python -m pip install tox
  3. Clone the repository
  4. Start a new branch off master: git switch -c new-branch master
  5. Make your code changes
  6. Check that your code follows the style guidelines of the project: tox -e reformat && tox -e check
  7. (optional) Build the documentation: tox -e docs
  8. (optional) Run the tests: tox -e py39 (change the version number according to the Python you are using)
  9. Commit, push, and open a pull request!