feat(doc): Add rule for Peripheral Projects and describe the rule of joining and achriving

Signed-off-by: leonrayang <chl696@sina.com>
This commit is contained in:
leonrayang 2024-10-14 19:58:02 +08:00 committed by leonrayang
parent d18001a133
commit 206d5ddadf
2 changed files with 33 additions and 2 deletions

View File

@ -261,17 +261,33 @@ The CubeFS organization is open to receive new sub-projects under its umbrella.
into the __CubeFS__ organization, it has to meet the following criteria: 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 licensed under the terms of the Apache License v2.0
- Must be related to one or more scopes of the CubeFS ecosystem: - Must be closely related to one or more areas of the CubeFS ecosystem, and CubeFS relies heavily on these projects:
- CubeFS project artifacts (website, deployments, CI, etc) - CubeFS project artifacts (website, deployments, CI, etc)
- External plugins - External plugins
- Other storage related topics - Other storage related topics
- Must be supported by a Maintainer not associated or affiliated with the author(s) of the sub-projects - Must be supported by a Maintainer not associated or affiliated with the author(s) of the sub-projects
- sub-projects can have their own repositories but follow the same governance mechanism as the main project - sub-projects can have their own repositories but follow the same governance mechanism as the main project
- Joining a Sub-Projects requires submitting an issue in the main project to obtain a vote of approval from the TSC committee. Similarly, significant actions such as project archiving also require the consent of the TSC committee
The submission process starts as a Pull Request or Issue on the The submission process starts as a Pull Request or Issue on the
[cubefs/cubefs](https://github.com/cubefs/cubefs) repository with the required information [cubefs/cubefs](https://github.com/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__. mentioned above. Once a project is accepted, it's considered a __sub-project under the umbrella of CubeFS__.
## Peripheral Projects
Besides the main project CubeFS and its sub projects, other projects within the repository exist as peripheral projects.
The CubeFS organization is open to receive new peripheral 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
- Peripheral-projects can have their own repositories but follow the same governance mechanism as the main project
- Joining a Peripheral Project requires submitting an issue in the main project to obtain a vote of approval from the TSC committee. Similarly, significant actions such as project archiving also require the consent of the TSC committee
## Product Security Committee(PSC) ## Product Security Committee(PSC)
The [Product Security Committee](https://github.com/cubefs/cubefs/blob/master/security/security-release-process.md#product-security-committee) is responsible for organizing the entire response including internal communication and external disclosure but will need help from relevant developers and release leads to successfully run this process. The [Product Security Committee](https://github.com/cubefs/cubefs/blob/master/security/security-release-process.md#product-security-committee) is responsible for organizing the entire response including internal communication and external disclosure but will need help from relevant developers and release leads to successfully run this process.

View File

@ -263,15 +263,30 @@ CubeFS 的子项目与主项目密切相关,作为必要的补充,需要在
CubeFS 组织欢迎接收新的子项目加入其范围。要接受一个项目进入 __CubeFS__ 组织,必须满足以下标准: CubeFS 组织欢迎接收新的子项目加入其范围。要接受一个项目进入 __CubeFS__ 组织,必须满足以下标准:
- 必须根据 Apache 许可证 v2.0 的条款进行许可。 - 必须根据 Apache 许可证 v2.0 的条款进行许可。
- 必须与 CubeFS 生态系统的一个或多个范围相关: - 必须与 CubeFS 生态系统的一个或多个范围紧密相关并且被CubeFS依赖
- CubeFS 项目工件网站、部署、CI 等) - CubeFS 项目工件网站、部署、CI 等)
- 外部插件 - 外部插件
- 其他与存储相关的主题 - 其他与存储相关的主题
- 必须由与子项目作者无关的维护者支持。 - 必须由与子项目作者无关的维护者支持。
- 子项目可以拥有自己的代码库,但需遵循与主项目相同的治理机制。 - 子项目可以拥有自己的代码库,但需遵循与主项目相同的治理机制。
- 加入外围项目需要在主项目中提交 issue以获得 TSC 委员会的投票认可。同样,诸如项目归档等重大操作也需要经过 TSC 委员会的同意。
提交过程以 Pull Request 或 Issue 的形式开始,需在 [cubefs/cubefs](https://github.com/cubefs/cubefs) 仓库中提供上述所需信息。一旦项目被接受,便视为 __CubeFS__ 旗下的一个子项目。 提交过程以 Pull Request 或 Issue 的形式开始,需在 [cubefs/cubefs](https://github.com/cubefs/cubefs) 仓库中提供上述所需信息。一旦项目被接受,便视为 __CubeFS__ 旗下的一个子项目。
## 外围项目
除了主项目 CubeFS 及其子项目,其他仓库内的项目作为外围项目存在。
CubeFS 组织欢迎在其框架下接收新的外围项目。要将一个项目纳入 __CubeFS__ 组织,必须满足以下标准:
- 必须在 Apache License v2.0 的条款下获得许可
- 必须与 CubeFS 生态系统的一个或多个范围相关
- CubeFS 项目工件网站、部署、CI 等)
- 外部插件
- 其他与存储相关的主题
- 子项目可以拥有自己的仓库,但需遵循与主项目相同的治理机制
- 加入外围项目需要在主项目中提交 issue以获得 TSC 委员会的投票认可。同样,诸如项目归档等重大操作也需要经过 TSC 委员会的同意。
## 产品安全委员会 (PSC) ## 产品安全委员会 (PSC)
[产品安全委员会](https://github.com/cubefs/cubefs/blob/master/security/security-release-process.md#product-security-committee) 负责组织整个响应,包括内部沟通和外部披露,但需要相关开发人员和发布负责人提供帮助,以成功运行此过程。 [产品安全委员会](https://github.com/cubefs/cubefs/blob/master/security/security-release-process.md#product-security-committee) 负责组织整个响应,包括内部沟通和外部披露,但需要相关开发人员和发布负责人提供帮助,以成功运行此过程。