contributing.md

Contributing to Python Liquid

Hi. Your contributions and questions are always welcome. Feel free to ask questions, report bugs or request features on the issue tracker or on Github Discussions.

Table of contents

• Development
• Documentation
• Style Guides

Development

We use hatch to manage project dependencies and development environments.

Run tests with the test script.

$ hatch run test

Or, to test against the full matrix of supported Python versions.

$ hatch run test:test

And to test without the autoescape extra.

$ hatch run noescape:test

Lint with ruff.

$ hatch run lint

Typecheck with Mypy.

$ hatch run typing

Check coverage with pytest-cov.

$ hatch run cov

Or generate an HTML coverage report.

$ hatch run cov-html

Then open htmlcov/index.html in your browser.

Documentation

Documentation is built using Docusaurus. Find the source in the docs branch of this repository.

The docs folder in the root of this repository contains docs generated from Python docstrings, hosted on Read the Docs. The plan is to mirror this API documentation to the Docusaurus site with the help of Griffe.

Style Guides

Git Commit Messages

There are no hard rules for git commit messages, although you might like to indicate the type of commit by starting the message with docs:, chore:, feat:, fix: or refactor:, for example.

Python Style

All Python files are formatted using Black, with its default configuration.

Docstrings must use Google style docstrings.