Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
58 lines (45 loc) · 1.1 KB

CONTRIBUTING.md

File metadata and controls

58 lines (45 loc) · 1.1 KB

Contribution

Development

Setup

  1. Clone the repository

    git clone https://github.com/dldevinc/paper-streamfield

  2. Create a virtualenv

    cd paper-streamfield
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 .

  5. Run test project

    python3 manage.py migrate
python3 manage.py loaddata tests/fixtures.json
    python3 manage.py runserver

    Django admin credentials: admin / admin

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