Skip to content

Latest commit

 

History

History
38 lines (29 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

38 lines (29 loc) · 1.5 KB

Contributing

Get Started

Get started with make conda-dev to create a new python environment for the project. Activate the new environment and then explore the make py* targets.

Dependencies

  • the conda dependencies are in environment.yml.
  • the pip project dependencies are in requirements.txt
  • the pip development dependencies are in requirements.dev

Development

The make targets abstract away the details of development tools, but it's important to understand conda.

  • use a github-flow
    • checkout a new branch off the master branch
    • add changes to the lib and tests
    • add content to docs
  • the test suite uses pytest
    • make pytest and make pycoverage
  • the documentation is built with sphinx
    • run the sphinx-quickstart if the docs are not setup
    • make pydocs
  • format code with black
    • make pyformat
  • check code with flake8
    • make pyflake8
  • make pyclean to remove stale test and build artifacts

Once it's passing locally, push the new branch to the origin and create a merge request. The CI pipelines will run a suite of tests on each new commit to the merge request and most of them must pass to be able to merge the branch to master. Request a code review from a project maintainer.