Contribution Guide

​

Overview

Thank you for your interest in contributing to OpenOperator! We appreciate any contribution, whether it’s fixing bugs, improving documentation, or adding new features. This guide will help you get started and ensure a smooth contribution process.

​

Ways to Contribute

Here are some ways you can contribute to OpenOperator:

1. Report Bugs

   • Found a bug? Open an issue in the repository and include steps to reproduce it, expected behavior, and screenshots if applicable.

2. Suggest Features

   • Have an idea for a feature? Share your thoughts by opening an issue or starting a discussion.

3. Improve Documentation

   • Help us enhance the documentation by fixing typos, clarifying instructions, or adding new sections.

4. Fix Bugs or Implement Features

   • Take a look at the open issues and pick one that interests you. Issues labeled good first issue are great for beginners.

5. Code Reviews

   • Review pull requests submitted by other contributors to ensure high-quality contributions.

​

Getting Started

Follow these steps to contribute to OpenOperator:

1. Fork the Repository

   • Navigate to https//github.com/j0yk1ll/openoperator, click the Fork button in the top-right corner of the repository page to create a copy under your GitHub account.

2. Clone Your Fork

   • Clone your forked repository to your local machine:
     Copy

     git clone https://github.com/j0yk1ll/openoperator.git
     cd openoperator
     

3. Setup your local development environment

   • Follow the steps at https://openoperator.co/development/local-setup

4. Create a Branch

   • Create a new branch for your contribution:
     Copy

     git checkout -b my-feature-branch
     

5. Make Changes

   • Edit the code or documentation as needed. Make sure your changes follow the project’s style guidelines.

6. Test Your Changes

   • Run tests to ensure your changes don’t break anything:
     Copy

     pytest
     

7. Ensure standardized formatting

   • Format with black
   Copy

   uv run black .
   

   • Verify with ruff
   Copy

   uv run ruff check .
   

8. Commit Your Changes

   • Write clear and concise commit messages:
     Copy

     git commit -m "added new feature or fix bug"
     

9. Push Your Branch

   • Push your changes to your fork:
     Copy

     git push origin my-feature-branch
     

10. Open a Pull Request

    • Navigate to the original repository and click New Pull Request.
    • Provide a clear description of your changes in the pull request.

​

Guidelines

To ensure a smooth contribution process, please follow these guidelines:

• Code Style: Follow the code style guidelines used in the project (e.g., linting and formatting rules).
• Tests: Add or update tests for any changes you make to the code.
• Documentation: Update relevant documentation when making changes to features or adding new ones.
• Commit Messages: Write descriptive commit messages that explain your changes.

​

Community and Support

If you have questions or need help, feel free to:

• Open a discussion or issue on the repository.
• Join our community on Discord.

Thank you for contributing to OpenOperator! Together, we can make this project better for everyone.

Happy coding! 🚀