菜单

贡献者鸣谢

相关源文件

本页面介绍了用于鸣谢前端开发者面试问题仓库贡献者的系统。它解释了如何追踪贡献者、认可哪些类型的贡献以及如何在整个项目中显示贡献者信息。有关如何成为贡献者的信息,请参阅贡献流程

概述

前端开发者面试问题项目采用 All Contributors 规范,以正式认可所有类型的贡献,而不仅仅是代码。该系统确保所有对项目有所帮助的人——无论是通过代码、文档、翻译还是其他方式——都能获得适当的鸣谢。

来源:.all-contributorsrc1-1212 CONTRIBUTORS.md1-200 src/_data/contributors.json1-1212

All Contributors 规范

本项目实现了All Contributors 规范,该规范旨在认可所有类型的贡献。.all-contributorsrc 文件作为贡献者信息的真实来源。

配置结构

.all-contributorsrc 文件包含以下关键配置元素

来源:.all-contributorsrc1-12

认可的贡献类型

本项目认可多种类型的贡献,每种贡献在生成的贡献者列表中都由特定的表情符号表示。

贡献类型表情符号描述
ideas🤔想法、规划与反馈
doc📖文档
infra🚇基础设施(托管、构建工具)
review👀审查拉取请求
question💬回答问题
talk📢演讲或演示
maintenance🚧维护工作
翻译🌍内容翻译
content🖋内容创作
code💻代码贡献
design🎨设计工作

来源:.all-contributorsrc17-25 .all-contributorsrc940-946

贡献者数据结构

配置文件中的每个贡献者条目都包含特定的元数据,用于识别贡献者及其贡献。

配置中的一个贡献者条目示例

{
  "login": "darcyclarke",
  "name": "Darcy Clarke",
  "avatar_url": "https://avatars2.githubusercontent.com/u/459713?v=4",
  "profile": "http://darcyclarke.me/",
  "contributions": [
    "ideas",
    "doc",
    "infra",
    "review",
    "question",
    "talk",
    "maintenance"
  ]
}

来源:.all-contributorsrc12-26

贡献者展示实现

贡献者信息主要显示在两个位置

  1. GitHub 仓库CONTRIBUTORS.md 文件以格式化表格形式显示贡献者信息
  2. 项目网站src/_data/contributors.json 文件由 Eleventy 静态网站生成器用于在网站上显示贡献者信息

CONTRIBUTORS.md 结构

CONTRIBUTORS.md 文件显示一个徽章,显示贡献者总数,并以每行 6 名贡献者的表格格式组织贡献者信息。

来源:CONTRIBUTORS.md1-3 .all-contributorsrc10

与网站集成

贡献者数据也被复制到 src/_data/contributors.json,以便 Eleventy 静态网站生成器可以使用。这使得网站无需直接访问 .all-contributorsrc 文件即可显示贡献者信息。

来源:src/_data/contributors.json1-1212

贡献者统计

截至最新更新,本项目认可了 100 多名贡献者,他们有各种不同的贡献类型

翻译是最常见的贡献类型,这反映了项目的国际性质以及其专注于提供多语言面试问题的特点。

来源:CONTRIBUTORS.md2 .all-contributorsrc1-1212

添加和更新贡献者

本项目使用标准化的工作流程来添加新贡献者或更新现有贡献者信息

当新的贡献被提交并合并时,项目维护者会使用 All Contributors CLI 工具将贡献者添加到 .all-contributorsrc 文件或更新其贡献类型。CLI 工具会自动更新 CONTRIBUTORS.md 文件。维护者随后手动将更新的数据复制到 src/_data/contributors.json 以供网站使用。

来源:.all-contributorsrc1-9 CONTRIBUTORS.md1-10 src/_data/contributors.json1-10

与 GitHub 工作流集成

贡献者鸣谢系统与 GitHub 的协作功能集成,以简化识别和鸣谢贡献者的过程

来源:.all-contributorsrc1-1212 CONTRIBUTORS.md1-200

与其他项目组件的交叉引用

贡献者鸣谢系统是项目更广泛的社区方面不可或缺的一部分,如项目文档第 6 节所述。

本项目认可与项目不同方面相符的各种贡献类型

  • 翻译贡献者负责第 3 节描述的翻译系统
  • 代码/基础设施贡献者负责第 4 节和第 5 节描述的组件
  • 文档贡献者帮助创建和维护第 2 节描述的面试问题

这一全面的鸣谢系统有助于维护前端开发者面试问题项目周围充满活力的社区。