Contributing

Contributions are welcome! We are excited to see the community help improve and grow DuoORM.

Getting Started

If you're interested in contributing, here's how you can get started:

1. Fork the repository on GitHub.
2. Clone your fork to your local machine.
3. Set up a virtual environment and install the development dependencies:

   # Create and activate a virtual environment
   python -m venv .venv
   source .venv/bin/activate
   
   # Install the package in editable mode with development extras
   pip install -e ".[dev]"
   

4. Make your changes. Please add tests for any new features or bug fixes.
5. Run the test suite to ensure everything is working correctly.

   # Example for SQLite
   pytest --db-url "sqlite:///./test.db"
   

Testing architecture (fixtures-first)

The test suite is organized around fixtures in tests/conftest.py and a single shared model registry in tests/models.py.

• tests/models.py defines the canonical test models and exposes registry(db) plus schema_tables(...). Prefer adding new test models there instead of creating ad-hoc models inside tests.
• db_session (sync) and async_db_session (async) fixtures provide a clean, isolated database state per test using a transaction + savepoint strategy.
• model_registry gives you access to the shared models; core_models and async_core_models return common (User, Post, db) tuples for convenience.

Adding a new isolated test

1. Add or extend models in tests/models.py if the test needs new tables.
2. Use db_session or async_db_session to get an isolated database context.
3. Fetch models via model_registry (or core_models/async_core_models) instead of re-defining them in the test.
4. Submit a pull request with a clear description of your changes.

Areas for Contribution

We are looking for help in several areas:

• Bug Fixes: If you find a bug, please open an issue first, and then feel free to submit a pull request with a fix.
• New Features: If you have an idea for a new feature, please open an issue to discuss it.
• Documentation: Improvements to the documentation are always welcome.
• Dialect Support: Expanding and improving support for different database backends (MySQL, Oracle, MSSQL) is a high priority.

Thank you for your interest in contributing to DuoORM!