Skip to content

Contributing to OptiReduce

We welcome contributions to OptiReduce! This guide explains how to contribute effectively to the project.

Contributing Code

Pull Request Process

  1. Create a feature branch for the specific repo: 

    git checkout -b feature/your-feature-name

  2. Make your changes and commit: 

    git commit -m "Description of changes"

  3. Update documentation if needed:

    • New features
    • Configuration options
    • Performance implications

  4. Submit a pull request

Pull Request Checklist

Before submitting your pull request, please ensure:

  • Documentation is updated
  • Performance impact has been considered
  • Backwards compatibility is maintained
  • Code follows style guidelines
  • All tests pass

Reporting Issues

Bug Reports

When reporting a bug, please include:

  • OptiReduce version (or better yet commit number)
  • System configuration
  • Network environment
  • Steps to reproduce
  • Expected vs actual behavior
  • Relevant logs

Feature Requests

When requesting a feature, please describe:

  • Use case
  • Expected benefits
  • Performance requirements
  • Resource implications

Communication

We have several channels for communication:

  • GitHub Issues: Bug reports and feature requests
  • Email: Technical discussions and security reports