Contributing

Note

This section is under development. Detailed contribution guidelines will be added in a future release.

Overview

We welcome contributions to rompy-oceanum! This project is part of the rompy ecosystem and follows similar development practices.

Getting Started

For now, please:

  1. Check the GitHub repository for current issues and discussions

  2. Follow the existing code style and patterns in the codebase

  3. Ensure any new features include appropriate tests

  4. Update documentation for any new functionality

Development Setup

# Clone the repository
git clone https://github.com/rom-py/rompy-oceanum.git
cd rompy-oceanum

# Install in development mode
pip install -e ".[dev,docs]"

# Run tests
pytest

# Build documentation
cd docs
make html

Contribution Types

We welcome:

  • Bug reports and fixes

  • Feature requests and implementations

  • Documentation improvements

  • Example workflows and tutorials

  • Performance optimizations

See Also