Contibuting

Just open an issue or submit a pull request on GitHub.

While submitting a pull request describe what changes have been made.

More info on Docs section

Contributors Wall

Try to adhere as much as possible to the Python style and language conventions.
Add unit tests for classes and methods.
When writing features exposed in API, always add documentation following the Google Style Python docstrings.

This package is developed using Python version 3.8.

This package uses poetry to handle dependencies, you can install them with:

poetry install -E pagination

Black is used to provide code autoformatting e linting. Before committing your changes run black:

black .

mypy is used to statically type check the source code. Before committing your changes run mypy:

mypy fastapi_responseschema

Tests are written using pytest. To run the test suite just type in your terminal:

pytest

This will generate the coverage in html format in a root level directory htmlcov.

Documentation is built using pydoc-markdown. To run the documentation dev server:

novella -d docs --serve

To build the docs:

novella -d docs