Skip to content

Latest commit

 

History

History
51 lines (26 loc) · 2.05 KB

CONTRIBUTING.md

File metadata and controls

51 lines (26 loc) · 2.05 KB

Contributing to yugabyte-k8s-operator

Welcome to yugabyte-k8s-operator. We're glad you're interested in contributing.

Getting Started

To contribute to yugabyte-k8s-operator, please follow these steps:

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your contribution (git checkout -b new-feature).
  4. Make your changes and commit them (git commit -am 'Add new feature').
  5. Push your changes to your forked repository (git push origin new-feature).
  6. Submit a pull request to the main repository.

Reporting Bugs

If you find a bug in yugabyte-k8s-operator, please open a new issue on GitHub. Please include as much detail as possible, including steps to reproduce the bug and your environment.

Adding Features

If you'd like to add a new feature to yugabyte-k8s-operator, please open an issue on GitHub to discuss it first. Once the feature is approved, follow the steps above to contribute your changes.

Code Style

Please follow the existing code style of yugabyte-k8s-operator when making changes. If you're unsure about the code style, please refer to the project's documentation or ask for guidance in your pull request.

Testing

Before submitting your changes, please ensure that all existing tests pass and that you've added tests for any new functionality. If you're unsure how to write tests, please ask for assistance.

Code Review

All pull requests will undergo code review. Please be open to feedback and be prepared to make changes to your code based on the feedback received.

Community

Join our community on [Slack/Discord/IRC/etc.] to connect with other contributors and users of yugabyte-k8s-operator. We welcome all contributions and value the input of our community members. For assistance or issues related to the Yugabyte Kubernetes Operator, please reach out to us on slack https://communityinviter.com/apps/yugabyte-db/register

Thank You

Thank you for contributing to yugabyte-k8s-operator! Your contributions help make this project better for everyone.