Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (24 loc) · 1.31 KB

CONTRIBUTING.md

File metadata and controls

42 lines (24 loc) · 1.31 KB

Contributing to mongo-validations-generator

First off, thanks for taking the time to contribute to mongo-validations-generator! Your help is welcome and appreciated 🙌

This document outlines the guidelines for contributing to the project.

🧠 Project Style Guide

This project uses:

  • PEP 8 for Python style
  • ruff for linting and formatting
  • pytest for testing

Please ensure that your contributions are formatted and pass type checks before submitting a PR.

✅ Submitting a Pull Request

Before opening a pull request:

  • Update the version in pyproject.toml and CHANGELOG.md. We follow Semantic Versioning (SemVer):

    • Increment the patch version for bug fixes.
    • Increment the minor version for new features.
    • Increment the major version for breaking changes.

  • Update the changelog in CHANGELOG.md:

    • Add a new ## x.y.z heading at the top.
    • Clearly list what was added, changed, or fixed.

  • Write tests for any new behavior or bug fix, ideally in tests/test_*.py.

🙋 Questions?

Open an issue or start a discussion if you're unsure how to contribute. We're happy to help you get started!

Thanks again for your contributions 💙