Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (36 loc) · 921 Bytes

CONTRIBUTING.md

File metadata and controls

46 lines (36 loc) · 921 Bytes

Contribution

Development

Setup

  1. Clone the repository 
    git clone https://github.com/dldevinc/cardpointe-api-python-client
  2. Create a virtualenv 
    cd cardpointe-api-python-client
virtualenv .venv
  3. Activate virtualenv 
    source .venv/bin/activate
  4. Install dependencies as well as a local editable copy of the library 
    pip install -r ./requirements.txt
pip install -e .

Pre-Commit Hooks

We use pre-commit hooks to simplify linting and ensure consistent formatting among contributors. Use of pre-commit is not a requirement, but is highly recommended.

pip install pre-commit
pre-commit install

Commiting will now automatically run the local hooks and ensure that your commit passes all lint checks.

Testing

To run unit tests:

pytest