Contributing to KubeSphere Console

The following is a set of guidelines for contributing to KubeSphere Console. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table Of Contents

Code of Conduct

How Can I Contribute?

• Reporting Bugs
• Pull Requests

Styleguides

• Git Commit Messages
• JavaScript Styleguide

Code of Conduct

All members of the KubeSphere community must abide by Code of Conduct. Only by respecting each other can we develop a productive, collaborative community.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for KubeSphere Console. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

When you are creating a bug report, please fill out the required template, the information it asks for helps us resolve issues faster.

Before Submitting A Bug Report

• Check the FAQs on the docs for a list of common questions and problems.
• Check the Forum to see if there is a way to resolve.
• Perform a cursory search to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.

Pull Requests

The process described here has several goals:

• Maintain KubeSphere Console's quality
• Fix problems that are important to users

Please follow these steps to have your contribution considered by the maintainers:

1. Follow all instructions in the template
2. Follow the styleguides
3. After you submit your pull request, verify that all status checks are passing
   What if the status checks are failing?

   If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.

While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.

Styleguides

Git Commit Messages

Follow the Conventional Commits 1.0.0.

JavaScript Styleguide

Follow the Airbnb Javascript Style Guide.

This project use Eslint to format code. Check the rules in .eslintrc.js

CSS, SCSS Styleguide

Using Prettier to fommat css and scss files. Check the rules in .prettierrc