Skip to content

Commit

Permalink
modify
Browse files Browse the repository at this point in the history
  • Loading branch information
xiaoyu committed Dec 16, 2024
1 parent a688464 commit fa498e4
Show file tree
Hide file tree
Showing 11 changed files with 49 additions and 536 deletions.
14 changes: 3 additions & 11 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -43,29 +43,21 @@ export default defineConfig({
{
text: '提案',
items: [
{text: '提案创作指南', link: '/guides/proposal'}
{text: '提案创作指南', link: '/guides/mentor'}
],
},
{
text: '孵化指南',
items: [
{text: '角色与职责', link: '/guides/roles_and_responsibilities'},
{text: '贡献者', link: '/guides/committer'},
{text: '项目管理委员会', link: '/guides/ppmc'},
{text: '社区成熟建设指南', link: '/guides/community'},
],
},
{
text: 'PMC指南',
items: [
{text: '参与指南', link: '/guides/participation'},
],
},
{text: '常见问题解答', link: '/faq'},
],
footer: {
message: 'Licensed under the Apache License, Version 2.0.',
copyright: 'Copyright © 2024 The Dromara Software Foundation'
message: '',
copyright: 'Copyright © 2024 The dromara.org'
},
socialLinks: [
{
Expand Down
56 changes: 5 additions & 51 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,66 +9,20 @@ title: 常见问题解答 (FAQ)
### 1. 孵化流程

#### 1.1 项目X必须通过孵化器进入Dromara吗?
是的。从DSF(Dromara Software Foundation)外部引入的代码只能通过孵化器进入DSF。孵化器负责以下工作:
是的。从dromara 开源组织外部引入的代码只能通过孵化器进入dromara 开源组织。孵化器负责以下工作:
* 确认许可证符合要求;
* 确保版权许可已到位;
* 要求所有初始开发者提交CLA(贡献者许可协议)。
* 更改项目包名和包路径(org.dromara.xxx)。
* 如果需要发布到MavenRepo,需要由IPMC批准。并且更改 groupId 为org.dromara。

孵化器还为项目提供学习DSF工作方式的机会,由IPMC成员(导师)指导。

#### 1.2 我是项目的导师,觉得自己可以完成所有工作。能否跳过孵化器?
不能。孵化是一个正式的流程,旨在确保项目按规定被引入DSF,并为将来的IP问题提供记录。DSF不会允许任何项目跳过这个流程,因为这样可能会破坏监督的有效性。

#### 1.3 为什么项目XXX没有提到孵化器?该怎么迁移到Dromara的XXX项目下?
#### 1.2 为什么项目XXX没有提到孵化器?该怎么迁移到Dromara的XXX项目下?
孵化过程的职责划分如下:
1. 项目进入孵化器需要某个Dromara PMC(包括IPMC)作为发起人;
1. 项目进入孵化器需要某个Dromara TOC 成员(包括IPMC)作为发起人;
2. 一旦IPMC接管,指定的导师将负责监督项目的孵化进度;
3. 项目需每季度向IPMC提交进展报告,直到毕业为止;
4. 毕业后,如果是其他PMC发起的项目,它将转交给发起PMC,否则需董事会批准成立独立PMC。

要迁移到XXX项目,请先请求XXX PMC担任你的项目发起人,随后进入孵化流程。

#### 1.4 如果有人提议将他们的代码捐赠给DSF的项目X,该怎么操作?
孵化器只有在PMC投票通过接受代码时才会接纳代码:
1. 相关项目需在公共邮件列表上讨论此提议;
2. PMC投票决定是否赞助代码(或相关项目);
3. 若同意,PMC应联系孵化器,并按照IP Clearance流程记录捐赠。

#### 1.5 捐赠的代码来自DSF外部,是不是完全归我们处置?
并非如此。以下几点需注意:
* DSF中没有一个代码库可以独占某种通用技术;
* 初始代码库仅仅是“初始”,未来的代码和架构方向由社区决定;
* 任何感兴趣的贡献者都可以向DSF代码库贡献代码或提出相关项目。

### 2. 参与方式

#### 2.1 如何更新网站?
请参考网站更新指南。如果你不是Incubator项目的提交者,可以通过提交补丁的方式参与。

#### 2.2 如何更新项目的孵化状态?
查看维护Podlings摘要文件和项目状态页面的相关说明。

#### 2.3 为什么不使用问题跟踪系统记录孵化状态?
问题跟踪系统无法满足法律归档和认证需求。而版本控制系统(如SVN)提供了身份验证功能,确保录入状态信息的人拥有权限。

#### 2.4 如何更新孵化项目的网站?
阅读孵化政策,并参考网站指南。

#### 2.5 如何为基础设施站点获取Karma权限?
向孵化器的通用邮件列表发送请求。

#### 2.6 如何搭建Podling网站?
搭建网站需首先申请Karma权限。

#### 2.7 如何为现有Dromara提交者授予Karma权限?
阅读权限授予指南。

#### 2.8 孵化器管理有哪些辅助工具?如何生成和维护这些工具?
参阅孵化器管理工具设施。

### 3. 基础设施

#### 3.1 我们的项目如何申请资源?
通过项目的开发邮件列表和PPMC协作处理。详细说明请参阅导师指南和基础设施说明。

此FAQ旨在为参与Dromara孵化器项目提供清晰指导。如果有进一步的问题,请在邮件列表中提出。
72 changes: 0 additions & 72 deletions docs/guides/committer.md

This file was deleted.

24 changes: 2 additions & 22 deletions docs/guides/community.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,19 @@ footer: true
title: 社区成熟建设指南
---

# Dromara 开源社区 :: 社区成熟建设指南
# 社区成熟建设指南

## 摘要
本文旨在帮助每个项目团队理解构建开放和多样化社区的重要性。提供了接纳新贡献者、核心成员的指导,以及如何让更多人参与社区建设的建议。

## 什么是开放和多样化的社区?
Dromara 社区的目标是构建一个开放、多样化、基于贡献价值的社区。这样的社区比封闭的社区更具活力和生产力。
Dromara开源组织的目标是构建一个开放、多样化、基于贡献价值的社区。这样的社区比封闭的社区更具活力和生产力。

## 人员
随着项目的发展,接纳新贡献者是社区自我更新的必要方式。项目需要探索如何吸引新的开发者和贡献者加入社区。接纳新贡献者有助于提升社区的多样性和项目的长期发展。虽然社区建设需要耗费精力,但这是对项目未来的必要投资。

社区的开放性不仅体现在贡献者数量上,还包括在交流中保持尊重和开放。社区成员需要学会通过有效的沟通来解决技术分歧,同时维护良好的人际关系。

## 沟通
邮件列表是 Dromara 社区交流的核心渠道,也是项目的公共和历史记录。其他形式的沟通(如点对点、即时消息、线下会议等)仅作为补充。尽量避免因为非公开沟通导致部分成员被排除在外。

Dromara 社区的邮件列表是公开的、可归档的,任何人都可以实时或通过历史记录了解项目进展。公开表达意见不仅有助于透明,也能维护社区成员的信誉。

**私下沟通**虽然有时更直接,但可能引发分歧,削弱社区的凝聚力。因此,重大事项需回归到公开渠道进行讨论。

如果项目使用其他形式的沟通,应确保重要内容归档并回归邮件列表。还需定期提醒社区成员其他沟通方式的存在。

## 社区建设
在项目正式成为社区重点项目之前,需构建一个多样化且可持续的社区。这需要时间、努力和一些巧妙的方法。社区建设可能需要开发者暂时减少编码工作,将更多时间投入到社区建设上。

Expand All @@ -41,16 +32,5 @@ Dromara 社区的邮件列表是公开的、可归档的,任何人都可以实
- 提交会议演讲
- 撰写博客和技术文章

## 激励用户转变为开发者
如果项目用户众多,但活跃开发者较少,可以采取措施鼓励用户参与开发:
- 鼓励有经验的用户回答问题,甚至故意留出时间让用户提供答案。
- 对于用户提出的好建议,邀请他们提交补丁或参与实现。
- 对用户回答的正确内容表示认可,帮助他们建立信心。

## 帮助开发者成为贡献者
如果开发者活跃度高但难以长期参与,可能是社区的接纳流程需要优化。对贡献进行及时的反馈和认可非常重要。例如:
- 迅速审查并处理补丁或拉取请求。
- 在提交信息和关闭问题时给予贡献者明确的署名。
- 鼓励开发者参与新的任务并引导其深入社区。

通过这些实践,Dromara 开源社区可以构建一个充满活力和包容性的社区,为项目的长期发展提供坚实的基础。
6 changes: 6 additions & 0 deletions docs/guides/mentor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
layout: home
footer: true
title: 导师列表
---
# 导师列表
41 changes: 0 additions & 41 deletions docs/guides/participation.md

This file was deleted.

80 changes: 6 additions & 74 deletions docs/guides/ppmc.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,100 +4,32 @@ footer: true
title: 项目管理委员会
---

# Dromara 开源社区 :: 项目管理委员会(PPMC)指南
# 项目管理委员会(PPMC)指南

## PPMC 角色与职责

PPMC 的主要职责是帮助项目孵化团队(Podling)学会自我治理。PPMC 的运作方式类似于 PMC,但它向孵化器 PMC(IPMC)报告,而非直接向 ASF 董事会报告
PPMC 的主要职责是帮助孵化项目学会自我治理。让项目更好的发展,为社区贡献者提供指导

### PPMC 的构成

- **初始成员:** 由项目导师和初始贡献者组成。
- **职责:**
- 监督孵化项目。
- 决定是否新增 PPMC 成员。

## 私密邮件列表

- **私密邮件地址:** `private@project`,用于讨论机密主题。
- **使用注意:**
- 避免将私人和公开邮件列表混合使用。
- 多数讨论应在开发邮件列表(`dev@project`)中进行。
- 私密列表仅用于讨论不适合公开的问题,如新增贡献者或 PPMC 成员资格的适宜性。

### 验证订阅情况
- 使用 [Whimsy Podling Roster]() 检查订阅情况。
- 可发送测试邮件验证成员是否已订阅。
- 项目发布、和升级。
- 提名新的 PPMC,Committer 成员

## 项目状态报告

- **提交频率:**
- 初创项目每月报告一次,三个月后改为每季度一次
- 初创项目每月报告一次。
- **报告内容:**
- 孵化器 PMC 或 ASF 董事会需关注的事项。
- 是否存在法律、基础设施或跨项目问题。
- 孵化过程中的障碍。
- 上次报告以来的进展。
- 下阶段计划。
- 导师活跃度等。
- **撰写指南:**
- 在开发邮件列表中讨论并协作完成报告。
- 使用最新模板,避免更改主题格式。
- **导师签署:**
- 导师必须签署报告,否则报告将不被接收。

### 提交报告步骤
1. 在孵化器的 [Wiki 页面]() 添加报告。
2. 遵循提醒邮件中的指示,使用指定模板提交至 `<Month><Year>` 页面。

## 项目状态页面

- 每个孵化项目在孵化器网站上有一个状态页面,记录其状态。
- 参考 [孵化器网站指南]() 了解如何更新。

## 新增贡献者和 PPMC 成员

### 新增贡献者

- **标准:**
- 各孵化项目可根据自身情况决定新增贡献者的标准。
- 通常保持较低门槛,以鼓励更多参与。
- **流程:**
1. 在私密邮件列表中发起 `[DISCUSS]``[VOTE]` 线程。
2. 投票通过后,向提名者发出邀请。
3. 导师按照流程完成新增贡献者的操作。
4. 引导新贡献者参考 [Dromara 开发者页面]() 和相关指南。

### 新增 PPMC 成员

- **目标:** 鼓励所有贡献者成为 PPMC 成员,关注其社区参与表现。
- **流程:**
1. 在私密邮件列表中发起 `[DISCUSS]` 讨论线程。
2. 一致同意后,发起 `[VOTE]` 线程。
3. 投票通过后,由 PPMC 成员发送 `[VOTE][RESULT]` 邮件通知 IPMC。
4. 正式邀请新成员,并指导其订阅相关邮件列表。

## 导师管理

### 新增导师

- **资格:** 导师需为 IPMC 成员。
- **流程:**
- IPMC 成员可主动提出加入导师团队。
- PPMC 决定是否接受新的导师。
-[Whimsy]() 中更新导师信息。

### 移除导师

- 如果导师无法履职或长期未参与,可由其他导师在 Whimsy 上将其移除。

## PPMC 的决策与投票

- **投票权:**
- PPMC 成员的投票仅在新增成员和贡献者时具有约束力。
- 发布投票仅限 IPMC 成员具有约束力。
- **注意事项:**
- 投票的约束力与邮件列表无关。
- 使用正式流程并记录所有投票结果。
- 导师必须查看、审核和签署报告,并且提交给 TOC 委员会。

以上指南旨在帮助 Dromara 开源社区的 PPMC 成员有效地管理项目,并为社区的长期健康发展奠定基础。
Loading

0 comments on commit fa498e4

Please sign in to comment.