all-contributors-cli 是一个命令行工具，用于向您的 GitHub 存储库添加贡献者和项目成员信息。在本文中，我们将介绍如何使用 all-contributors-cli 将贡献者信息添加到您的存储库中。这将帮助您更好地展示团队成员的贡献，并提高他们在开源社区中的能见度。
安装 all-contributors-cli
要开始使用 all-contributors-cli，首先需要安装它。可以通过 npm 来进行安装。
npm install -g all-contributors-cli
安装完成之后，您可以输入以下命令来检查 all-contributors-cli 是否成功安装：
all-contributors --version
如果一切顺利，该命令应该输出 all-contributors-cli 当前的版本号。
初始化 all-contributors 配置文件
要开始使用 all-contributors-cli，您需要在您的项目中初始化 all-contributors 配置文件。您可以使用以下命令完成此操作：
all-contributors init
运行此命令会生成 .all-contributorsrc 文件，其中包含了有关所有贡献者列表的配置信息。可以选择直接编辑该文件或使用 all-contributors 命令行工具来添加、修改或删除贡献者信息。
添加贡献者
要添加新的贡献者，请使用以下命令：
all-contributors add <github-username> <contribution-type>
<github-username> 是贡献者的 GitHub 用户名，<contribution-type> 是该用户所做出的贡献类型。例如，如果 John Smith 参与了您的项目，并且他是一个代码贡献者，您可以使用以下命令将其添加到 all-contributors 列表中：
all-contributors add johnsmith code
为了向 all-contributors 列表中添加其他类型的贡献者，可以使用以下命令：
all-contributors add <github-username> doc all-contributors add <github-username> bug all-contributors add <github-username> design
生成贡献者列表
一旦 all-contributors 配置文件中包含所有贡献者信息，就可以使用 all-contributors-cli 生成 Markdown 格式的贡献者列表。可以使用以下命令完成此操作：
all-contributors generate
这将在项目根目录下创建 CONTRIBUTORS.md 文件，并将 all-contributors 列表的信息插入其中。现在，当您发布新版本时，可以将 CONTRIBUTORS.md 文件包含在发行说明中，以更好地展示贡献者信息。
自定义输出格式
all-contributors-cli 还提供了许多选项来自定义贡献者列表的输出格式。以下是一些常用的选项：
--project-name: 指定项目名称，将在文件头部显示。--image-size: 指定头像图片大小，单位为像素。--contributors-per-line: 指定每行显示的贡献者数量。
例如，以下命令将生成将每行显示 7 个贡献者并指定项目名称为 "My Project" 的贡献者列表：
all-contributors generate --contributors-per-line=7 --project-name="My Project"
结论
通过使用 all-contributors-cli，您可以轻松地向您的开源存储库中添加贡献者信息，并更好地展示项目成员的贡献。all-contributors-cli 还提供了许多选项来自定义贡献者列表的输出格式，使其适合您的项目需求。最后，希望这篇文章能够帮助您更好地了解 all-contributors-cli，并
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/49650