菜单

存储库结构

相关源文件

目的与范围

本文档提供了“命令行艺术”项目的仓库结构的详细说明。它概述了文件在仓库中的组织方式、主要内容与其翻译之间的关系以及贡献者信息的管理方式。有关指南中涵盖的命令行工具生态系统的信息,请参阅命令行基础知识

存储库概览

“命令行艺术”仓库的结构非常简洁,专注于以多种语言提供命令行知识。该仓库由三个主要组件组成:

  1. 主要内容:主要英文指南(README.md
  2. 翻译:指南的多语言版本
  3. 贡献者管理:跟踪作者、翻译者和维护者的文件

仓库文件结构

来源:README.md1-33

该仓库的结构极简,主要包含用于内容的 Markdown 文件和一个小型管理目录。没有构建脚本、源代码文件或复杂的目录层级,这使得贡献者更容易参与。

主要内容结构

英文指南(README.md)是所有翻译的权威来源。它分为涵盖命令行使用不同方面的专题部分。

内容组织

来源:README.md9-19 README.md34-47

内容遵循循序渐进的学习结构,从基础概念开始,进阶到更专业和特定于平台的技巧。每个部分都包含简洁的命令行提示、示例和说明,不过度冗长。

翻译系统

该仓库托管了主要指南的多种语言翻译版本。每个翻译都保存在一个单独的 Markdown 文件中,遵循 README-{语言代码}.md 的命名约定。

语言和维护者

该项目有一个成熟的翻译维护者系统,他们负责特定语言版本的监督。

语言文件维护者
中文(简体)README-zh.md曾楚杰 (Psycho7)
中文(繁体)README-zh-Hant.mdkevingo
俄语README-ru.mdOleg Berman (olegberman)
西班牙语README-es.mdCarlos Mantilla (ceoaliongroo)
葡萄牙语README-pt.mdNilton Vasques (niltonvasques)
韩语README-ko.mdUngsik Yun (Ungsik-Yun)
日语README-ja.mdHayato Matsuura (doublemarket)
法语README-fr.mdÉric Guirbal (ericguirbal)
意大利语README-it.mdFrancesco Malatesta (francescomalatesta)
德语README-de.mdMartin Folkers (S1SYPHOS)
乌克兰语README-uk.mdDmytro Kovalov (dmytro)
斯洛文尼亚语README-sl.mdPeter Kokot (petk)
捷克语README-cs.mdlsrom
希腊语README-el.mdAnna Damtsa (anna-d)
罗马尼亚语README-ro.mdMihai Maruseac (mihaimaruseac)
印度尼西亚语README-id.mdAhmad 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

贡献者信息存储在两个主要文件中:

  1. AUTHORS.md:自动生成的包含所有贡献者及其 GitHub 用户名、角色和贡献指标的文件。此文件是自动生成的。

  2. 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.pngREADME 中使用的图片

来源:README.md22 README.md26 README.md32

这种简单的结构使新贡献者能够轻松理解仓库组织,并有效地做出贡献,而无需浏览复杂的目录层级。