Skip to content

Latest commit

 

History

History
45 lines (33 loc) · 1.05 KB

CONTRIBUTING.md

File metadata and controls

45 lines (33 loc) · 1.05 KB
Raw

Contributing

You can use the environments created by tox for development. It helps install pre-commit hooks and mypy type checker.

tox -e dev
source .tox/dev/bin/activate

Testing

This project uses tox for managing test environments. There are some pre-configured environments that can be used for linting and formatting code when you're preparing contributions to the charm:

tox -e fmt           # update your code according to linting rules
tox -e lint          # code style
tox -e unit          # unit tests
tox -e integration   # integration tests

⚠️ NOTE

The python-openldap dependency requires several software packages to be install at the first hand. Please run tox -e build-prerequisites before running any tests.

Build the charm

Build the charm in this git repository using:

charmcraft pack -v

Render the database schema diagram

The following command generates an SVG diagram of the database schema used by the backend datastore.

tox -e render-database-diagram