菜单

贡献者鸣谢

相关源文件

本文档描述了用于认可和感谢 Node.js Best Practices 仓库贡献者的系统。它解释了如何识别、跟踪和在项目文档中直观地表示贡献者。有关成为贡献者流程的信息,请参阅贡献工作流程

1. 认可系统概述

Node.js Best Practices 仓库使用All Contributors规范来认可对项目的所有类型贡献。该系统确保每位贡献者,无论其贡献类型如何,都能得到适当的认可。

来源:.all-contributorsrc1-1761

2. 贡献类型

该项目认可各种类型的贡献,每种贡献类型在贡献者列表中都有特定的标签标识。

贡献类型描述表情符号标签
内容添加或改进内容(最佳实践、解释)📝
翻译将内容翻译成其他语言🌍
审阅审阅拉取请求和内容👀
安全与安全相关的贡献🔒
示例添加示例或代码片段💡
文档文档改进📖
代码代码贡献💻

来源:.all-contributorsrc24-26 .all-contributorsrc799-800 .all-contributorsrc935-937 .all-contributorsrc1061-1064 .all-contributorsrc1334-1337

3. 技术实现

贡献者认可系统在技术上是通过 .all-contributorsrc 配置文件和 All Contributors 机器人来实现的。

来源:.all-contributorsrc1-13 .all-contributorsrc14-17

3.1 配置文件结构

.all-contributorsrc 文件包含生成 README 文件中贡献者列表所需的所有元数据。主要组件包括:

  1. 文件列表:指定哪些 README 文件应包含贡献者列表
  2. 模板:定义贡献者和徽章的视觉显示方式
  3. 贡献者数组:包含每位贡献者的详细信息

来源:.all-contributorsrc1-17 .all-contributorsrc18-27

4. 视觉表示

贡献者通过头像网格在仓库文档中直观地表示,每个头像都链接到贡献者个人资料并显示其贡献类型。

4.1 贡献者网格

贡献者网格显示了所有贡献者及其头像、姓名和贡献类型。此网格出现在配置文件中指定的所有 README 文件中。

来源:.all-contributorsrc16 .all-contributorsrc14-17

4.2 特殊认可图标

对于项目中的特定角色,例如委员会成员和协作者,会创建特殊的颜色编码图标来区分他们的贡献。

角色边框颜色视觉区分
委员会成员#33cd32 (绿色)头像周围实心绿色边框
贡献者#0efeff (青色)头像周围实心青色边框

来源:assets/images/members/create-member-icon.md1-45

5. 贡献者添加流程

当新贡献者对仓库做出贡献时,他们将通过特定流程被添加到认可系统中。

来源:.all-contributorsrc1754-1757

6. 管理和维护

贡献者认可系统由核心团队成员维护,他们确保所有贡献者都因其工作得到适当的认可。

6.1 添加新贡献者

核心团队成员可以使用 All Contributors 机器人命令在问题或拉取请求中将新贡献者添加到系统中。

命令语法是:

@all-contributors please add @username for contribution_type

其中 contribution_type 是公认的贡献类型之一(内容、翻译等)。

来源:.all-contributorsrc1754-1760

6.2 更新贡献类型

对于做出新类型贡献的现有贡献者,可以通过以下方式更新他们的条目:

@all-contributors please add @username for new_contribution_type

这将保留他们现有的贡献类型并添加新类型。

来源:.all-contributorsrc23-27 .all-contributorsrc825-828

7. 贡献者认可的好处

贡献者认可系统为 Node.js Best Practices 项目带来了诸多好处:

  1. 可见性:所有贡献者都能获得对其工作的公开认可
  2. 激励:认可鼓励持续参与和新的贡献
  3. 社区建设:营造社区感和共同所有权
  4. 透明度:提供对项目贡献者的清晰记录
  5. 包容性:认可所有类型的贡献,不仅仅是代码

来源:.all-contributorsrc1-1761

8. 总结

Node.js Best Practices 仓库采用基于 All Contributors 规范的全面贡献者认可系统。该系统确保所有贡献者,无论贡献类型如何,都能获得对其工作的适当认可。README 文件中贡献者的视觉表示有助于建立社区感并鼓励项目持续参与。