CONTRIBUTING.md

Welcome to the OpenOps Contributing Guide 👋

Thank you for considering contributing to OpenOps — any contribution is welcome!

Your involvement helps improve FinOps automation for everyone, and this guide outlines how to contribute effectively.

🌟 How You Can Contribute

Here are some common ways to contribute to OpenOps:

• Report bugs
• Suggest features
• Submit pull requests
• Improve documentation: Notice any gaps or errors? Open an issue in our Docs repository. Feel free to submit a PR with corrections. If you open a PR, please reference the issue number.
• Spread the word: Share your experience with OpenOps through blog posts, talks, or social media ❤️
• Join the OpenOps Community on Slack to discuss ideas, ask questions, connect with other users and contributors:

🐛 Reporting Bugs

If you find a bug:

1. Search existing issues to check if it has already been reported.
2. Open a new issue if one does not exist. Please include:
   • A descriptive title
   • Steps to reproduce
   • Expected and actual behavior
   • Screenshots or logs (if applicable)
   • Your environment (OS, browser, version, etc.)

We take every bug report seriously and appreciate your help in making OpenOps better.

Please let us know if you plan to submit a PR to address the issue.

💡 Suggesting Features

To propose a new feature:

1. Search existing issues to ensure it hasn't already been suggested. To support an existing suggestion, react with 👍.
2. Propose a feature using the Feature Request template. Include:
   • A clear description of the feature
   • The problem it solves
   • Any relevant context or examples
   • Potential implementation ideas, if you have them

You can also discuss feature ideas in the Slack community.

We love innovative ideas that help take OpenOps to the next level!

🚀 Creating a Pull Request

You're welcome to submit PRs that address reported bugs or add new features.

External contributors often submit PRs introducing integrations with tools relevant to the FinOps community, such as cloud platforms, optimization services, and project management tools.

Before making significant changes, please discuss them in the relevant issue or in the OpenOps Community to ensure alignment and gather feedback.

To contribute code changes:

1. Fork this repository to create your own copy.
2. Create a branch with a descriptive name (e.g., fix-issue-xyz, feature-abc).
3. Set up the development environment.
4. Make changes in your branch. See the OpenOps Contributing Guide for guidance on specific tasks, such as choosing an authentication method or developing an integration. When contributing:
   • Follow existing code style and patterns
   • Write clear, self-documenting code with descriptive variable and function names
   • Add comments for complex or non-obvious logic
5. Test your changes. Add or update tests to ensure your code works as expected and doesn't break existing functionality.
6. Commit changes with clear, concise commit messages.
7. Push to your fork.
8. Open a Pull Request from your fork to this repository.
9. Describe your changes clearly in the PR description.

By contributing to OpenOps, you agree that your work will be licensed under the project's Apache 2.0 License.

🎉 Recognition

We believe in recognizing contributions. Once accepted, contributors will be:

• Mentioned in the release notes
• Considered for early access to new features

🙏 Many Thanks to Other OSS Projects!

OpenOps builds on and extends work from other open-source projects, such as ActivePieces, Baserow, Superset, React Flow, and more.

Huge thanks to the OSS community — we're proud to be part of it and contribute back.

❓ Questions?

If you have any questions about contributing, please reach out:

We appreciate your contributions and look forward to collaborating with you!