Contributing#

We welcome contributions to Synora! This guide covers how to get started.

Development Setup#

  1. Clone the repository

    git clone https://github.com/ParamThakkar123/synora.git
cd synora

  2. Install in development mode

    uv sync --dev

    If you are not using uv, use the equivalent editable install:

    python -m pip install -e ".[dev]"

  3. Install pre-commit hooks

    uv run pre-commit install

Code Style#

We use:

  • Black for code formatting

  • Ruff for linting

  • MyPy for type checking

  • Pre-commit for automated checks

Run checks:

# Format code
uv run black .

# Lint
uv run ruff check .

# Type check
uv run mypy .

# All checks
uv run pre-commit run --all-files

Testing#

Run the test suite:

# All tests
pytest

# Fast subset (skip slow, GPU, and integration tests)
pytest -m "not slow and not gpu and not integration"

# Specific package-mirrored test area
pytest tests/masks/test_masks.py

# With coverage
pytest --cov=synora --cov-report=html

Documentation#

Build docs locally:

cd docs
sphinx-build -b html source build/html

Open docs/build/html/index.html in your browser.

Adding New Features#

1. New Models#

  1. Create model class in synora/models/

  2. Add config class in synora/configs/

  3. Export both from synora/__init__.py

  4. Update training scripts

  5. Add documentation and tests

2. New Environments#

  1. Implement environment wrapper in synora/envs/

  2. Add to environment registry

  3. Update documentation

Pull Request Process#

  1. Fork the repository

  2. Create a feature branch

    git checkout -b feature/my-feature

  3. Make your changes

  4. Run tests and checks

    uv run pre-commit run --all-files
uv run pytest

  5. Update documentation if needed

  6. Commit your changes

    git commit -m "Add feature: my feature"

  7. Push to your fork

    git push origin feature/my-feature

  8. Create a Pull Request

Commit Messages#

Use conventional commit format:

  • feat: New features

  • fix: Bug fixes

  • docs: Documentation

  • test: Testing

  • refactor: Code refactoring

  • chore: Maintenance

Examples:

  • feat: add I-JEPA linear evaluation

  • fix: resolve memory leak in dreamer training

  • docs: update inference guide

Issue Reporting#

  • Bug reports: Use the bug report template

  • Feature requests: Use the feature request template

  • Questions: Use discussions

Code of Conduct#

Please follow our code of conduct in all interactions.

License#

By contributing, you agree that your contributions will be licensed under the MIT License.