Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

37 lines (24 loc) · 1.68 KB
Raw

Issues & Contributing

If you have an issue with PyCap or the REDCap API, please raise an issue on the issues page. We'll do our best to help where we can.

PyCap follows the Fork-Pull workflow method for accepting contributions. If you'd like to contribute code to PyCap, please use the following workflow:

  1. If you don't already have an account on GitHub, please make one.
  2. Fork this repo to your own account.
  3. Checkout a branch & commit your changes. See the section on poetry below for instructions how to set up your local development environment. Tests are definitely appreciated 💯!
  4. Push those changes to your repo & submit a Pull-Request to this repository.

If any of these steps are unclear, please peruse the helpful GitHub Guide on Forking or file an issue, and we'll try to help out!

Using poetry

This package uses poetry for dependency management and publishing. It is required in order to do local development with PyCap.

  1. Install poetry
$ curl -sSL https://install.python-poetry.org | python3 -
  1. Install all project dependencies (including development/optional dependencies).
$ poetry install -E data_science
  1. Add your changes and make sure your changes pass all tests.
$ poetry run pytest

If you make changes to the dependencies you'll need to handle them with the poetry add/remove commands.