Skip to content

Latest commit

 

History

History
53 lines (42 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

53 lines (42 loc) · 1.67 KB
Raw

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repositories using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Following our coding conventions

To format the python test files we use black. After installing like this you can run the following before committing:

make format

You can also run the following to automatically format all the files that you have changed before committing.

cat > .git/hooks/pre-commit << __EOF__
#!/bin/bash
black --check --quiet . || { black .; exit 1; }
__EOF__
chmod +x .git/hooks/pre-commit

Running tests

In one shell start a docker compose citus cluster:

docker-compose --project-name django-multitenant up -d || { docker-compose logs && false ; }

Then in another shell run the tests:

export DJANGO_VERSION=4.1
export CITUS_VERSION=11.2
make test-dependencies 
make test