CONTRIBUTING.md

Contributing

Getting started

This project uses poetry to handle production and development dependencies.

To install all dependencies, you simply need to run:

poetry install

To run tests:

poetry run pytest

To run the type-checker:

poetry run mypy

To run the formatter:

poetry run black .

To lint the project:

poetry run pylint sqlschm tests

The tests are based on snapshots that are stored in tests_corpus. To generate the corpus run:

PYTHONPATH="$PWD" python scripts/generate_corpus.py

Commit messages

The project adheres to the conventional commit specification.

The following commit prefixes are supported:

• feat:, a new feature
• fix:, a bugfix
• docs:, a documentation update
• test:, a test update
• chore:, project housekeeping
• perf:, project performance
• refactor:, refactor of the code without change in functionality

See the git log for well-formed messages.

Changelog

The project keeps a changelog that document every change that is visible to the user.