The CubeFS community adheres to the following principles:
- Open: CubeFS is open source.
- Welcoming and respectful: See Code of Conduct.
- Transparent and accessible: Changes to the CubeFS organization, CubeFS code repositories, and CNCF related activities (e.g. level, involvement, etc) are done in public.
- Merit: Ideas and contributions are accepted according to their technical merit and alignment with project objectives, scope, and design principles.
The CubeFS project has a project lead.
A project lead in CubeFS is a single person that has a final say in any decision concerning the CubeFS project.
The term of the project lead is one year, with no term limit restriction.
The project lead is elected by CubeFS maintainers according to an individual's technical merit to CubeFS project.
The current project lead is identified in the top level MAINTAINERS file with the string
project lead and the term behind the name.
Every one carries water...
Making a community work requires input/effort from everyone. Maintainers should actively participate in Pull Request reviews. Maintainers are expected to respond to assigned Pull Requests in a reasonable time frame, either providing insights, or assign the Pull Requests to other maintainers.
Every Maintainer is listed in the top-level MAINTAINERS file.
Committer is an active contributor in the community who continuously makes contributions to the community by contributing codes, documentation, participating in community discussions, or helping community users answer questions, etc.
Typically, they need to have a good understanding of the project to help more community users quickly join the project. After becoming a committer, you will be responsible for reviewing relevant issues or PRs, and your opinions are also extremely important to the community.
Every Committer is listed in the top-level MAINTAINERS file.
If you are interested in becoming a committer, please email [email protected], and you will receive an invitation letter from the community after the review is passed.
On successful merge of a significant pull request any current maintainer can reach
to the author behind the pull request and ask them if they are willing to become a CubeFS
maintainer. The email of the new maintainer invitation should be cc'ed to [email protected]
as part of the process.
If a Maintainer feels she/he can not fulfill the "Expectations from Maintainers", they are free to step down.
Maintainers of a repository (or a directory) can lose their status by voluntarily stepping down for personal reasons, or due to inactivity.
In such a case:
A PR is required to move the person in question from the maintainer entry to the retirement entry of the respective OWNERS file. The person in question must be mentioned in the body of the PR. This acts as a final contact attempt so that they can provide their feedback.
Only for core maintainers who are losing their status: remove them from the core-maintainers team; go to https://maintainers.cncf.io/ and open a PR to remove them under CubeFS; remove them from the cubefs.groups.io/g/maintainers mailing list.
Changes in project lead or term is initiated by opening a github PR.
Anyone from CubeFS community can vote on the PR with either +1 or -1.
Only the following votes are binding:
- Any maintainer that has been listed in the top-level MAINTAINERS file before the PR is opened.
- Any maintainer from an organization may cast the vote for that organization. However, no organization should have more binding votes than 1/5 of the total number of maintainers defined in 1).
The PR should only be opened no earlier than 6 weeks before the end of the project lead's term. The PR should be kept open for no less than 4 weeks. The PR can only be merged after the end of the last project lead's term, with more +1 than -1 in the binding votes.
When there are conflicting PRs about changes in project lead, the PR with the most binding +1 votes is merged.
The project lead can volunteer to step down.
Changes in project governance (GOVERNANCE.md) could be initiated by opening a github PR.
The PR should only be opened no earlier than 6 weeks before the end of the project lead's term.
The PR should be kept open for no less than 4 weeks. The PR can only be merged follow the same
voting process as in Changes in Project Lead.
Decisions are build on consensus between maintainers.
Proposals and ideas can either be submitted for agreement via a github issue or PR,
or by sending an email to [email protected].
In general, we prefer that technical issues and maintainer membership are amicably worked out between the persons involved. If a dispute cannot be decided independently, get a third-party maintainer (e.g. a mutual contact with some background on the issue, but not involved in the conflict) to intercede. If a dispute still cannot be decided, the project lead has the final say to decide an issue.
Decision making process should be transparent to adhere to the principles of CubeFS project.
All proposals, ideas, and decisions by maintainers or the project lead
should either be part of a github issue or PR, or be sent to [email protected].
The cubefs GitHub project maintainers team reflects the list of Maintainers.
The CubeFS organization is open to receive new sub-projects under its umbrella. To accept a project into the CubeFS organization, it has to meet the following criteria:
- Must be licensed under the terms of the Apache License v2.0
- Must be related to one or more scopes of the CubeFS ecosystem:
- CubeFS project artifacts (website, deployments, CI, etc)
- External plugins
- Other storage related topics
- Must be supported by a Maintainer not associated or affiliated with the author(s) of the sub-projects
The submission process starts as a Pull Request or Issue on the cubefs/cubefs repository with the required information mentioned above. Once a project is accepted, it's considered a sub-project under the umbrella of CubeFS.
The CubeFS is open to receive new plugins as part of the CubeFS repo. The submission process is the same as a Pull Request submission. Unlike small Pull Requests though, a new plugin submission should only be approved by a maintainer not associated or affiliated with the author(s) of the plugin.
CubeFS might be involved in CNCF (or other CNCF projects) related
marketing, events, or activities. Any maintainer could help driving the CubeFS involvement, as long as
she/he sends email to [email protected] (or create a GitHub Pull Request) to call for participation
from other maintainers. The Call for Participation should be kept open for no less than a week if time
permits, or a reasonable time frame to allow maintainers to have a chance to volunteer.
The CubeFS Code of Conduct is aligned with the CNCF Code of Conduct.
Sections of this documents have been borrowed from CoreDNS, Fluentd and Envoy projects.