Contributing¶

Prerequisites¶

Python >= 3.10
hatch (pipx install hatch)
pre-commit (pip install pre-commit)

Setup¶

git clone git@github.com:engFelipeMonteiro/mongomock-ng.git
cd mongomock-ng
pre-commit install

Running Tests¶

hatch test

Code Quality¶

# Lint
ruff check mongomock_ng/ tests/

# Auto-fix
ruff check --fix mongomock_ng/ tests/

# Format
ruff format mongomock_ng/ tests/

# Type check
python -m mypy -p mongomock_ng

Pre-commit Hooks¶

The project uses pre-commit hooks (ruff, ruff-format, mypy). To run manually:

pre-commit run --all-files

Branching Model¶

We use gitflow workflow. PRs should be issued against the develop branch.

Releasing¶

Update __version__ in mongomock_ng/__version__.py
Update CHANGELOG.md with the same version
Open a PR against develop — on merge, a tag v<version> is created automatically
The tag push triggers a build and publish to PyPI

Container Engine¶

The Makefile uses a configurable container engine via .container-engine:

echo podman > .container-engine   # default
echo docker > .container-engine