Skip to content

Latest commit

 

History

History
67 lines (51 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

67 lines (51 loc) · 1.54 KB
Raw

Contributing

The following is a set of guidelines for contributing to rapidsms-smpp-gateway on GitHub. Use your best judgement, and feel free to propose changes to this document in a pull request.

Table of contents

Local development

You will first need to clone the repository using git and place yourself in its directory:

git clone [email protected]:caktus/rapidsms-smpp-gateway.git
cd rapidsms-smpp-gateway/

Now, you will need to install the required dependencies for rapidsms-smpp-gateway and be sure that the current tests are passing on your machine:

# create python3.10 virtualenv
echo "layout python python3.10 > .envrc"
direnv allow
pip install -r dev-requirements.txt

To make sure that you don't accidentally commit code that does not follow the coding style, you can install a pre-commit hook that will check that everything is in order:

pre-commit install

Tests

# provide a postgres instance, optionally in a docker container
docker run \
    --detach \
    --rm \
    --name=smpp-test-db \
    -p 5432:5432 \
    -e POSTGRES_DB=test_database \
    -e POSTGRES_USER=test_user \
    -e POSTGRES_PASSWORD=test_password \
    postgres:15
# wait for DB to start up

pytest

# tear down test DB if desired
docker stop smpp-test-db

Install an editable version in another project

pip install -e ../rapidsms-smpp-gateway/