Welcome to the KubeClipper community!

Thank you for your interest in KubeClipper! This document provides the guidelines for how to contribute to the KubeClipper project through issues and pull-requests.

Before you start contributing, read our Code of Conduct

here are usually 3 types of issues:

• Bug report: You’ve found a bug with the code, and want to report it, or create an issue to track the bug.
• Feature Request: You think we need a new feature, describe the new feature.
• Proposal: Used for items that propose a new idea or functionality. This allows feedback from others before code is written.

1. Is it the right repository?
2. Check for existing issues
   1. Before you create a new issue, please do a search in open issues to see if the issue or feature request has already been filed.
   2. If you find your issue already exists, make relevant comments and add your reaction. Use a reaction:
      1. 👍 up-vote
      2. 👎 down-vote
3. For bugs
   1. Check it’s not an environment issue.
   2. You have as much data as possible. This usually comes in the form of logs and/or stacktrace.
4. For proposals
   1. proposals are always required before implementing new features

All contributions come through pull requests. To submit a proposed change, follow this workflow:

1. Make sure there’s an issue (bug or proposal) raised, which sets the expectations for the contribution you are about to make.
2. Fork the relevant repo and create a new branch
   1. See the Developing docs for more information about setting up a development environment.
3. Create your change
   1. Code changes require tests
4. Update relevant documentation for the change
5. Commit use git commit --signoff and open a PR
6. Wait for the CI process to finish and make sure all checks are green
7. A maintainer of the project will be assigned, and you can expect a review within a few days

Roadmap

Release-flow

All KubeClipper members here

• dapr/community
• kubesphere/community