diff --git a/CONTIRIBUTING.md b/CONTIRIBUTING.md new file mode 100644 index 0000000..b70c615 --- /dev/null +++ b/CONTIRIBUTING.md @@ -0,0 +1,33 @@ +# Contributing to KubeCub + +## Introduction + +Thank you for your interest in contributing to KubeCub! We appreciate your effort and to ensure that your contributions are integrated smoothly, we ask that you follow these guidelines. + +## How to Contribute + +1. **Fork the repository**: Start by forking the KubeCub repository to your own GitHub account. + +2. **Clone the repository**: Clone the forked repository to your local machine. + +3. **Create a new branch**: Always create a new branch for each contribution. + +4. **Make your changes**: Make your changes and improvements to the new branch. + +5. **Test your changes**: Ensure that your changes do not break any existing functionality. + +6. **Commit your changes**: Commit your changes with a clear and concise commit message. + +7. **Push your changes**: Push your changes to your forked repository. + +8. **Create a Pull Request**: Create a pull request from your forked repository to the main KubeCub repository. + +## Code of Conduct + +We follow the [Code of Conduct](https://github.com/KubeCub/code_of_conduct.md) of the open source community. Please make sure to read and follow it. + +## Questions + +If you have any questions, please open an issue and we will get back to you as soon as possible. + +Thank you for your contributions!