Get Involved

Gradient-Free-Optimizers is an open-source project and we welcome contributions from the community! There are many ways to get involved, whether you’re a developer, researcher, or user.

Ways to Contribute

Report Bugs

Found a bug? Please report it on GitHub:

  1. Search existing issues to see if it’s already reported.

  2. If not, open a new issue with:

    • A clear description of the problem

    • Steps to reproduce the issue

    • Expected vs actual behavior

    • Your Python version and GFO version

    • Minimal code example that reproduces the issue

See Getting Help for guidelines on reporting issues.

Suggest Features

Have an idea for a new feature or improvement?

  1. Open a GitHub Discussion to discuss your idea with the community.

  2. If there’s consensus, create an issue or pull request.

Contribute Code

Ready to contribute code? See the Contributing guide for:

  • Setting up your development environment

  • Running tests

  • Code style guidelines

  • Pull request process

Improve Documentation

Documentation improvements are always welcome:

  • Fix typos or unclear explanations

  • Add code examples

  • Improve API documentation

  • Translate documentation

Submit documentation changes via pull requests, just like code changes.

Help Others

Join the community and help others:

  • Answer questions in GitHub Discussions

  • Help triage issues

  • Review pull requests

  • Share your GFO use cases

Recognition

Contributors to Gradient-Free-Optimizers are recognized in:

  • GitHub contributor list

  • Release notes for features/fixes they contributed

  • Project documentation (for major contributions)

Thank You

Thank you for your interest in contributing to Gradient-Free-Optimizers! Every contribution, no matter how small, helps make the project better for everyone.

Note

If you’re new to open source, check out How to Contribute to Open Source for a gentle introduction.