本文档提供了“命令行艺术”项目的仓库结构的详细说明。它概述了文件在仓库中的组织方式、主要内容与其翻译之间的关系以及贡献者信息的管理方式。有关指南中涵盖的命令行工具生态系统的信息,请参阅命令行基础知识。
“命令行艺术”仓库的结构非常简洁,专注于以多种语言提供命令行知识。该仓库由三个主要组件组成:
README.md)该仓库的结构极简,主要包含用于内容的 Markdown 文件和一个小型管理目录。没有构建脚本、源代码文件或复杂的目录层级,这使得贡献者更容易参与。
英文指南(README.md)是所有翻译的权威来源。它分为涵盖命令行使用不同方面的专题部分。
来源:README.md9-19 README.md34-47
内容遵循循序渐进的学习结构,从基础概念开始,进阶到更专业和特定于平台的技巧。每个部分都包含简洁的命令行提示、示例和说明,不过度冗长。
该仓库托管了主要指南的多种语言翻译版本。每个翻译都保存在一个单独的 Markdown 文件中,遵循 README-{语言代码}.md 的命名约定。
该项目有一个成熟的翻译维护者系统,他们负责特定语言版本的监督。
| 语言 | 文件 | 维护者 |
|---|---|---|
| 中文(简体) | README-zh.md | 曾楚杰 (Psycho7) |
| 中文(繁体) | README-zh-Hant.md | kevingo |
| 俄语 | README-ru.md | Oleg Berman (olegberman) |
| 西班牙语 | README-es.md | Carlos Mantilla (ceoaliongroo) |
| 葡萄牙语 | README-pt.md | Nilton Vasques (niltonvasques) |
| 韩语 | README-ko.md | Ungsik Yun (Ungsik-Yun) |
| 日语 | README-ja.md | Hayato Matsuura (doublemarket) |
| 法语 | README-fr.md | Éric Guirbal (ericguirbal) |
| 意大利语 | README-it.md | Francesco Malatesta (francescomalatesta) |
| 德语 | README-de.md | Martin Folkers (S1SYPHOS) |
| 乌克兰语 | README-uk.md | Dmytro Kovalov (dmytro) |
| 斯洛文尼亚语 | README-sl.md | Peter Kokot (petk) |
| 捷克语 | README-cs.md | lsrom |
| 希腊语 | README-el.md | Anna Damtsa (anna-d) |
| 罗马尼亚语 | README-ro.md | Mihai Maruseac (mihaimaruseac) |
| 印度尼西亚语 | README-id.md | Ahmad Zafrullah (23Pstars) |
来源:README.md1-2 AUTHORS.md11-31 admin/authors-info.yml24-60
来源:AUTHORS.md6-8 admin/authors-info.yml3-9
翻译通过翻译维护者的努力与英文原文保持同步,他们负责审查贡献并确保在原文内容更改时保持一致性。
该项目维护着所有贡献者的详细记录,并按他们在项目中的角色进行组织。
来源:AUTHORS.md3-176 admin/authors-info.yml1-105
贡献者信息存储在两个主要文件中:
AUTHORS.md:自动生成的包含所有贡献者及其 GitHub 用户名、角色和贡献指标的文件。此文件是自动生成的。
admin/authors-info.yml:用于定义贡献者角色并提供生成 AUTHORS.md 所需信息的配置文件。
贡献者信息分为三个不同的组:
| 分组 | 描述 |
|---|---|
| 维护者 | 维护部分或语言翻译并审查贡献的人员 |
| 翻译者 | 将内容翻译成不同语言的贡献者 |
| 贡献者 | 为改进指南做出其他贡献的人员 |
来源:AUTHORS.md11-169 admin/authors-info.yml62-104
AUTHORS.md 文件是使用一个名为“ghizmo assemble-authors”的工具生成的,该工具处理 authors-info.yml 配置文件,并将其与 GitHub 的贡献数据结合起来。
该仓库具有扁平的结构,大多数文件都位于根目录下。
| 文件 | 目的 |
|---|---|
| README.md | 主要的英文指南 |
| README-*.md | 指南的翻译版本 |
| AUTHORS.md | 所有贡献者及其角色的列表 |
| admin/authors-info.yml | 贡献者管理的配置文件 |
| CONTRIBUTING.md | 贡献项目的指南 |
| cowsay.png | README 中使用的图片 |
来源:README.md22 README.md26 README.md32
这种简单的结构使新贡献者能够轻松理解仓库组织,并有效地做出贡献,而无需浏览复杂的目录层级。