community guide

This commit is contained in:
laiwei 2022-07-05 00:37:01 +08:00
parent 2a2a96d9fc
commit e62366b755
2 changed files with 50 additions and 7 deletions

50
doc/community-support.md Normal file
View File

@ -0,0 +1,50 @@
# Nightingale 项目和社区构成
## 用户 | User
欢迎任何个人、公司以及组织,使用 Nightingale并积极的反馈 bug、提交功能需求、以及相互帮助我们首选推荐使用 github issue 来管理跟踪 bug 和需求。
## 贡献者 | Contributer
欢迎每一位用户,包括但不限于以下列方式参与到 Nightingale 开源项目并做出贡献:
1. 在github issue中积极参与讨论
2. 提交代码补丁
3. 修订、补充和完善文档
4. 提交建议 / 批评
## 提交者 | Committer
Committer 是指拥有 Nightingale 代码仓库写操作权限的贡献者而且他们也签署了Nightingale项目贡献者许可协议CLA他们拥有ccf.org.cn 为后缀的邮箱地址。原则上 Committer 能够自主决策某个代码补丁是否可以合入到 Nightingale 代码仓库,但是 PMC 拥有最终的决策权。
## 项目管委会成员 | PMC Member
项目管委会成员,从贡献者或者 Committer 中选举产生,他们拥有 Nightingale 代码仓库的写操作权限,拥有 ccf.org.cn 为后缀的邮箱地址,拥有 Nightingale 社区相关事务的投票权、以及提名Committer 候选人的权利。 项目管委会作为一个实体,为整个项目的发展全权负责。
## 项目管委会主席 | PMC Chair
项目管委会主席采用任命制,由 CCF ODC 从 PMC 成员中任命产生。项目管委会作为一个统一的实体,来管理和领导 Nightingale 项目。管委会主席是 CCF ODC 和 PMC 之间的沟通桥梁,以履行特定的项目管理职责。
# 沟通机制 | Communication
1. 我们推荐使用邮件列表来反馈建议(待发布);
2. 我们推荐使用 github issue 管理跟踪 bug 和需求;
3. 我们推荐使用 github milestone 来管理项目进度和规划;
4. 我们推荐使用腾讯会议来定期召开项目例会;
# 文档 | Documentation
1. 我们推荐使用[github pages](https://n9e.github.io)来沉淀文档;
2. 我们推荐使用[gitlink wiki](https://www.gitlink.org.cn/ccfos/nightingale/wiki/faq) 来沉淀FAQ
# 运营机制 | Operation
1. 我们定期组织用户、贡献者、项目管委会成员之间的沟通会议,讨论项目开发的目标、方案、进度,以及讨论相关需求的合理性、优先级等议题;
2. 我们定期组织 meetup (线上&线下),创造良好的用户交流分享环境,并沉淀相关内容到文档站点;
3. 我们定期组织 Nightingale 开发者大会,分享 best user story、同步年度开发目标和计划、讨论新技术方向等
# 社区指导原则 | Philosophy
- 尊重、认可和记录每一位贡献者的工作;
# 关于提问的原则
按照“尊重、认可、记录每一位贡献者的工作”原则,我们提倡“高效的提问”,这既是对开发者时间的尊重,也是对整个社区的知识沉淀做贡献:
1. 提问之前请先查阅 [FAQ](https://www.gitlink.org.cn/ccfos/nightingale/wiki/faq)
2. 提问之前请先搜索 [github issue](https://github.com/ccfos/nightingale/issues)
3. 我们优先推荐通过提交 github issue 来提问,如果[有问题点击这里](https://github.com/ccfos/nightingale/issues/new?assignees=&labels=kind%2Fbug&template=bug_report.yml) | [有需求建议点击这里](https://github.com/ccfos/nightingale/issues/new?assignees=&labels=kind%2Ffeature&template=enhancement.md)
4. 最后,我们推荐你加入微信群,针对相关开放式问题,相互交流咨询,请先加好友:[UlricGO](https://www.gitlink.org.cn/UlricQin/gist/tree/master/self.jpeg) 备注:夜莺加群+姓名+公司,交流群里会有开发者团队和专业、热心的群友回答问题;

View File

@ -1,7 +0,0 @@
# 关于答疑
夜莺相关问题,我们推荐如下答疑方式:
- 我们整理了常见问题和解答,放到了 [FAQ](https://www.gitlink.org.cn/ccfos/nightingale/wiki/faq) 请大家先查阅FAQ再提问很多问题在FAQ中都可以找到答案
- [github issue](https://github.com/ccfos/nightingale/issues) 这是我们最推荐的方式,研发团队几乎每天都会查看,如果[有问题点击这里](https://github.com/ccfos/nightingale/issues/new?assignees=&labels=kind%2Fbug&template=bug_report.yml) | [有建议点击这里](https://github.com/ccfos/nightingale/issues/new?assignees=&labels=kind%2Ffeature&template=enhancement.md)
- 加入微信交流群,咨询群友,请先加好友:[UlricGO](https://www.gitlink.org.cn/UlricQin/gist/tree/master/self.jpeg) 备注:夜莺加群+姓名+公司,交流群里会有我们的同学每天答疑,也会有热心群友回答问题