Thank you for considering contributing to Flask-PyMongo!
For help and general questions, please consider using the flask-pymongo tag on StackOverflow instead of creating issues in the GitHub project. This will keep the issues in the project focused on actual bugs and improvement requests.
- Describe what you expected to happen.
- If possible, include a minimal, complete, and verifiable example to help us identify the issue. This also helps check that the issue is not with your own code.
- Describe what actually happened. Include the full traceback if there was an exception.
- List your Flask-PyMongo, PyMongo, and MongoDB versions. If possible, check if this issue is already fixed in the repository.
- All new features must include a test. Flask-PyMongo is tested against a matrix of all supported versions of Flask, PyMongo, and MongoDB, so tests ensure that your change works for all users.
- Use Sphinx-style docstrings
We use justfile for task running and uv for python project management.
To set up your dev environment, run just install.
To run the tests, run just test. You can pass arguments through to pytest.
To run the linters, run just lint.
To build the docs, run just docs and open _build/html/index.html in your browser to view the docs.