跳至内容

首次贡献者指南

每个人都有一个起点。如果您是第一次在 GitHub 上为开源文档做贡献，恭喜您迈出了这一步。我们迫不及待地想看到您的成果！ 为获得最佳效果，请阅读我们的风格指南，其中包含其他文档链接，可帮助您了解文档的最佳实践。

Git 和 GitHub

我们所有的贡献者说明都假定您已拥有 GitHub 帐户。如果您还没有，现在是时候了。如果您有 12 分钟时间，可以通过 Udemy 的Git 和 GitHub 新手指南了解 GitHub 的基础知识。

您可能不会从创建和管理 Rocky Linux 的仓库开始，但这个Hello World 教程将引导您完成创建 GitHub 帐户、学习术语以及理解仓库的工作原理。重点学习如何创建和提交对现有文档的更新，以及如何创建 Pull Request。

Markdown

Markdown 是一种易于使用的语言，允许在同一个文件中包含格式、代码和纯文本。当您第一次更新文档时，请遵循现有代码。很快您就可以探索其他功能。届时，以下是基本知识。

本地仓库编辑器

要创建本地仓库，请先找到并安装适合您的计算机和操作系统的 Markdown 编辑器。以下是一些选项，但还有其他选择。使用您熟悉的东西。

  • ReText - 免费、跨平台、开源
  • Zettlr - 免费、跨平台、开源
  • MarkText - 免费、跨平台、开源
  • Remarkable - Linux 和 Windows，开源
  • 对于 vi/vim 用户和 nvim 客户端，可以使用NvChad。有许多插件可用于增强 Markdown 编辑器。有关一套不错的安装说明，请参阅本文档。
  • VS Code - 部分开源，由 Microsoft 开发。VS Code 是一款轻量级且功能强大的编辑器，适用于 Windows、Linux 和 macOS。要为本项目文档做贡献，您应该安装以下扩展：Git Graph、HTML Preview、HTML Snippets、Markdown All in One、Markdown Preview Enhanced、Markdown Preview Mermaid Support，以及任何您喜欢的其他扩展。

创建本地仓库

安装 Markdown 编辑器后，请按照说明将其连接到您的 GitHub 帐户并将您的仓库下载到本地计算机。每次准备更新文档时，请遵循这些步骤同步您的本地和在线分支与主分支，以确保您使用的是最新版本。

  1. 在 GitHub 中，将您的文档仓库分支与主分支同步。
  2. 按照您的 Markdown 编辑器的说明将您当前的分支同步到您的本地计算机。
  3. 在您的 Markdown 编辑器中，打开您要更改的文档。
  4. 更改文档。
  5. 保存。
  6. 在您的编辑器中提交您的更改，这应该会将您的本地仓库与您的在线分支同步。
  7. 在 GitHub 中，在您的分支中找到更新的文档，然后创建一个 Pull Request 将其合并到主文档中。

提交更新

添加缺失的单词，纠正错误，或澄清令人困惑的文本。

  1. 从您要更新的页面开始。

    点击您要更新的文档右上角的“编辑”铅笔图标。这将带您到 GitHub 上的原始文档。

    当您第一次为 Rocky Linux (RL) 仓库贡献时，您会看到一个带有绿色按钮的提示：“Fork this repository and propose changes”（Fork 此仓库并提议更改）。这会创建一个 RL 仓库的副本，您将在其中进行建议的编辑。点击绿色按钮继续。

  2. 进行更改

    遵循 Markdown 格式。也许缺少一个单词，或者您需要修复第 21 行的链接。进行必要的更改。

  3. 提议更改

    在页面底部，在标题为“Propose changes”（提议更改）的块中写一个单行描述。引用文档顶部的文件名会有帮助，但并非必需。

    如果您更新了 Markdown 文本第 21 行中的链接，您可以写：“Update README.md with correct links”（用正确的链接更新 README.md）。

    注意：用现在时态描述您的操作。

    然后点击 Propose changes（提议更改），这会将您的更改Commit到您 Fork 的仓库中的完整文档。

  4. 审查更改

    现在您可以逐行审查您的更改。是否遗漏了什么？返回上一页再次进行更正（您将不得不重新开始），然后再次点击 Propose Changes。

    一旦文档符合您的要求，请点击名为 Create Pull Request 的绿色按钮。这为您提供了最后一次机会仔细检查您的更改并确认文档已准备就绪。

  5. 创建 Pull Request (PR)

    到目前为止，您所做的工作都在您自己的仓库中完成，没有机会破坏 RL 主仓库。接下来，您将其提交给文档团队，以便他们将您的版本合并到主文档版本中。

    点击名为 Create Pull Request 的大绿色按钮。好消息是，您还没有破坏任何东西，因为现在它将发送给 RL 文档团队进行审查。

  6. 等待

    一旦 RL 团队收到您的请求，他们将以以下三种方式之一做出回应。

    • 接受并合并您的 PR
    • 提供反馈并要求进行更改
    • 拒绝您的 PR 并附带解释

    最后一种回应不太可能发生。我们非常希望包含您的观点！如果您需要进行更改，您将很快明白为什么需要本地仓库。团队可以指导您下一步该怎么做。好消息是，这仍然是可以修复的。如果您需要添加或更改您的 pull request，团队成员会在评论部分添加。

    否则，团队将接受您的请求并合并。欢迎加入团队，您现在正式成为一名贡献者！几天后，您就可以在贡献者指南底部的 all-contributors 列表中看到您的名字。

作者：Krista Burdine

贡献者：Ezequiel Bruni, Steven Spencer, Ganna Zhyrnova