Skip to main content

Contributing

Welcome to HwameiStor!

Community guidelines​

HwameiStor is a sandbox project listed in the CNCF landscape. We follow CNCF Community Code of Conduct.

Requirements​

The source code of HwameiStor is written in golang and managed with git.

To easily install HwameiStor, you may need to have helm installed.

Getting involved​

Please check issues to see if there are any existing tasks you may be interested in.

In particular, if you're just getting started, you may want to look for issues labeled with help wanted or kind/bug, which are standard labels in the cloud-native communities.

If you're interested in working on any of these, please leave a comment to let us know!

Note:

Please open an issue or discussion before starting work on a new feature or large change.

What's next​

If you're planning to contribute code changes, the reviewers may need you to:

  • follow good coding guidelines.
  • write good commit messages.
  • break large changes into a logical series of smaller patches which individually make easily understandable changes, and in aggregate solve a broader issue.

If you're looking to contribute documentation improvements, you'll want to read the documentation.