CONTRIBUTING.md

Hello there friend! 👋

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

Your involvement will help improve FinOps automation for everyone, and this guide outlines how you can do it effectively.

🌟 How You Can Contribute

• Reporting and fixing bugs: If you encounter any issues, please open an issue to inform us. Please let us know if you plan to raise a PR for the issue.
• Suggesting Features: Have ideas for improvements? Propose a feature for discussion. We love every idea!
• Improving Documentation: Notice any gaps or errors in our documentation? Submit a PR with your corrections or enhancements in our docs repository.
• Sharing Use Cases: Real-world examples help others see the potential of OpenOps in their organizations.
• Joining the Community: We welcome you in the OpenOps Slack community.
• Spreading the Word: Tell others about OpenOps through blog posts, talks, or social media ❤️

🚀 Creating a Pull Request

To contribute code or documentation:

1. Fork the Repository: Create your own copy of the repository.

2. Create a Branch: Use a descriptive name, e.g., fix-issue-xyz or feature-abc.

3. Make Changes: Implement your changes in the new branch.

4. Test Your Changes: Ensure your code works as expected and doesn't break existing functionality.

5. Commit Changes: Write clear, concise commit messages.

6. Push to Your Fork: Push your changes to your GitHub fork.

7. Open a Pull Request: Navigate to the original repository and open a pull request from your forked repository.

8. Describe Your Changes: In the PR description, explain what your changes do and why they're needed.

Note: For any significant changes, we recommend discussing them via an issue or on our Slack before implementation to ensure alignment and gather feedback.

🐛 Reporting Bugs

If you find a bug:

1. Search Existing Issues: Check if the issue has already been reported.
2. Open a New Issue: If not found, create a new issue with:
   • A descriptive title.
   • Steps to reproduce the issue.
   • 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!

💡 Suggesting Features

To propose a new feature:

1. Search Existing Issues: Ensure the feature hasn't been suggested.
2. Open a New Issue: If not found, create a new issue and tag it as an improvement. Include:
   • A clear description of the feature.
   • The problem it solves.
   • Any relevant context or examples.
   • Potential implementation approaches, if you have ideas.
3. Through Slack: Discuss your ideas with the OpenOps team in the Slack community.

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

📝 Code Style Guidelines

When contributing code, please follow these guidelines:

• Follow existing code style and patterns in the repository.
• Write clear, self-documenting code with descriptive variable and function names.
• Include comments for complex logic or non-obvious behavior.
• Write tests for new functionality and any changes.
• Update documentation for user-facing changes.

🤝 Community

Join our community to discuss ideas, ask questions, and connect with other contributors:

🎉 Recognition

We believe in recognizing contributions. Contributors will be:

• Mentioned in the release notes once their contribution is accepted
• Considered for early access to new features.

❓ Questions?

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

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

🙏 Many Thanks to other OSS projects!

OpenOps leverages code from other open-source projects, such as ActivePieces, Baserow, Superset, React Flow, and more. Huge thanks to the OSS community; we are thrilled to be a part of it and contribute back.

---

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