Skip to content

Latest commit

 

History

History
137 lines (91 loc) · 5.27 KB

CONTRIBUTING.md

File metadata and controls

137 lines (91 loc) · 5.27 KB

Contributing to MayaStor

We're excited to have you interested in contributing to MayaStor!

If you experience minor hurdles in contribution, please report them.

If you have any questions, our ecosystem can be connected with over Discord (for development) and Slack (invite, for support).

Our interactions here are governed by the CNCF Code of Conduct.

Development Environment

Consult the doc/build.md for a complete guide to getting started contributing to MayaStor.

Issues & Pull Requests

Reporting Bugs

You would be the best if you reported complete, well described, reproducible bugs to us. If you can't, that's ok. Do your best.

Our Bug Report template includes instructions to get the the information we need from you.

Requesting new features

You are invited to open complete, well described issues proposing new features. While MayaStor has no formal RFC process at this time, the Rust RFC template is an excellent place to derive your issue description from.

You should indicate if you are able to complete and support features you propose.

Committing

Start work off the develop branch. Not master.

bors will merge your commits. We do not do squash merges.

Each commit message must adhere to Conventional Commits. You can use convco if you would prefer a tool to help.

It is absolutely fine to force push your branch if you need. Feel free to rewrite commit history of your pull requests.

Reviews

The review process is governed by bors.

Pull requests require at least 1 approval from maintainer or SIG member.

Once review is given, Maintainers and SIG members may indicate merge readiness with the comment bors merge.

Please do not hit the 'Update Branch' button. The commit message is not conventional, bors will yell at you. Let bors handle it, or rebase it yourself.

Organization

Our maintainers are:

Our Special Interest Groups (SIGs) are:

Former SIGs (and their members) are:

  • None, yet!

Organization FAQs

  • What is a Maintainer?

    Maintainers are the project architects. They have the final say on what features get accepted, what code gets merged, when releases are cut, and how the project evolves.

    Maintainers must make decisions unanimously, no majorities, no votes.

  • What is a Special Interest Group (SIG)?

    SIGs are small ephemeral teams (max 7) working on a general topic.

    They may change at any time, and have no strict definition.

    SIGs may be created, empowered, and destroyed by the maintainers at any time.

  • Are there other levels/roles/organization structure?

    No. We want to focus on building MayaStor.

    It's preferable that we flow like water as opposed to become a rue goldberg machine of rules.

  • May I join a SIG? Become a maintainer?

    Of course, we'd love that!

    Once you have a bit of contribution history with the project you will probably already find yourself working with a SIG, so ask, and they'll include you.

    Once you have acted as part of multiple SIGs, contributed at least one major feature, and resolved multiple bug reports, our maintainers may choose to include you in their midst.