Skip to content

Contributing

Thank you for your interest in contributing to DREAMS Research Pipeline!

Development Setup

  1. Fork and clone the repository
  2. Create a virtual environment
  3. Install dependencies: pip install -r requirements.txt
  4. Install dev dependencies: pip install mkdocs-material mkdocs-minify-plugin

Documentation

Local Development

# Serve docs locally with live reload
mkdocs serve

# Build static site
mkdocs build

Guidelines

  • Use clear, concise language
  • Include code examples where helpful
  • Update the relevant docs when modifying pipeline code

Code Style

  • Follow PEP 8 conventions
  • Use type hints for function signatures
  • Document public functions with docstrings

Pull Requests

  1. Create a feature branch from main
  2. Make your changes
  3. Update documentation if needed
  4. Submit a pull request with a clear description