Skip to content

Latest commit

 

History

History
66 lines (34 loc) · 2.65 KB

contributing.md

File metadata and controls

66 lines (34 loc) · 2.65 KB
Raw

Contributing to Operating

Welcome to KusionStack Operating! KusionStack Operating consists of workloads and operators built on Kubernetes Custom Resource Definitions. We're excited that you're interested in contributing. Please take a moment to read through this guide to understand how you can contribute to this project.

Quick Start

We welcome contributions from the community, whether it's reporting a bug, requesting a new feature, or submitting code changes.

Bug Reports

If you find a bug or issue in the project, please follow these steps:

  1. Check the Issues section to see if the issue has already been reported. If not, create a new issue.

  2. Provide a clear and detailed description of the issue, including steps to reproduce it.

  3. Include any error messages or screenshots, if applicable.

Feature Requests

If you have an idea for a new feature or improvement, please follow these steps:

  1. Check the Issues section to see if the feature request already exists. If not, create a new issue.

  2. Clearly describe the feature you'd like to see and why it would be valuable to the project.

  3. Engage in discussions on the feature request to gather feedback and refine the proposal.

Hands-on

There are issues with labels help wanted and good first issue, which are specially selected for new contributors. Please feel free to get started from these issues.

Developing Guide

Pull Requests

If you'd like to contribute code changes or enhancements, please follow these steps:

  1. Fork the repository to your GitHub account.

  2. Create a new branch from the main branch for your changes.

  3. Make your code changes and commit them to your branch.

  4. Write meaningful commit messages that describe your changes.

  5. Ensure your code adheres to our coding standards and guidelines.

  6. Submit a Pull Request (PR) to the main branch of this repository.

  7. Your PR will be reviewed, and feedback or additional changes may be requested.

  8. Once your PR is approved, it will be merged into the main branch.

Sign CLA

If it was your first pull request, you need to sign our CLA(Contributor License Agreement). The only thing you need to do is to post a pull request comment same as the below format:

I have read the CLA Document and I hereby sign the CLA

If your CLA signature failed, you may find the solutions as below:

  • The comment must be in exactly the same format as above, with no extra spaces, line breaks, etc.
  • The git committer must be the same one who create the Kusion PR