Skip to content

Latest commit

 

History

History
38 lines (20 loc) · 1.36 KB

CONTRIBUTING.md

File metadata and controls

38 lines (20 loc) · 1.36 KB
Raw

Contributing Guidelines

Thank you for wanting to explore and contribute to aequilibrium!

Below are the instructions on how to setup a development version of aequilibrium, but contributions to the documentation and issue-resolving are very welcome.

Sign CLA

Before contributing to this CVS Health sponsored project, you will need to sign the associated Contributor License Agreement.

Setup for Development

  • First, clone the repo:

    git clone --recursive https://github.com/cvs-health/aequilibrium && cd aequilibrium

  • Next, create and activate a virtual python environment (using conda or venv).

  • Finally, install aequilibrium for development:

    pip install -e .

Common Errors

  • If you're on Windows, make sure that your command line/terminal has administrator privileges.

Nothing Works?

Did nothing work for you? Contact one of the repo's contributors for help. If you have encountered and solved another installation issue, you are very welcome to add it do the documentation here and submit a PR.

Submitting a Pull Request

We work using forks and Pull Requests.

In order to submit a PR for aequilibrium, one must fork the repository and submit the PR from there.

Please make sure your fork is up-to-date with the aequilibrium's latest main branch.