跳到内容

首次贡献者指南

每个人都有自己的起点。如果你这是第一次为 GitHub 上的开源文档做出贡献，恭喜你迈出了这一步。我们迫不及待地想看看你有什么要说的！

Git 和 GitHub

我们所有的贡献者指南都假定您拥有 GitHub 帐户。如果您从未创建过 GitHub 帐户，现在就是时候了。如果您有 12 分钟的时间，可以使用 Udemy 的 Git 和 GitHub 初学者指南 学习 GitHub 的基本知识。

您可能不会一开始就创建和管理 Rocky Linux 的存储库，但这个 Hello World 教程 将引导您完成创建 GitHub 帐户、学习术语以及了解存储库的工作原理。专注于学习如何对现有文档进行更新和提交，以及如何创建拉取请求。

Markdown

Markdown 是一种简单的语言，允许您在同一个文件中包含格式、代码和纯文本。您第一次更新文档时，请遵循现有代码。您很快就会准备好探索其他功能。当需要的时候，这里有基础知识。

本地存储库编辑器

要创建本地存储库，首先找到并安装与您的计算机和操作系统兼容的 Markdown 编辑器。这里有一些选项，但还有其他选项。使用您所知道的。

  • ReText - 免费、跨平台、开源
  • Zettlr - 免费、跨平台、开源
  • MarkText - 免费、跨平台、开源
  • Remarkable - Linux 和 Windows，开源
  • NvChad 适用于 vi/vim 用户和 nvim 客户端。许多插件可用于增强编辑器以支持 Markdown。请查看 此文档 以获取一组不错的安装说明。
  • VS Code - 部分开源，由微软提供。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. 在你的编辑器中提交你的更改，这将同步你的本地仓库和在线 fork。
  7. 在 GitHub 中，找到你 fork 中的更新文档，并创建一个 Pull Request 来将其合并到主文档中。

提交更新

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

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

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

    你第一次贡献到 RL 仓库时，你会看到一个绿色的按钮，提示你“Fork 此 仓库 并提出更改”。这会创建 RL 仓库的一个副本，你在其中进行你建议的编辑。只需点击绿色按钮并继续。

  2. 进行你的更改

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

  3. 提出更改

    在页面底部，在名为“提出更改”的块的标题中写一个一行描述。引用文档顶部的文件名是有帮助的，但不是必需的。

    因此，如果你更新了 markdown 文本第 21 行中的一个链接，你可以说类似“更新 README.md 以包含正确的链接”。

    注意：用现在时态措辞你的行动。

    然后点击“提出更改”，这将提交你的更改到你的 fork 仓库中的完整文档。

  4. 审查更改

    现在你可以逐行查看你所做的更改。你有没有遗漏什么？回到上一页并再次更正它（你将不得不重新开始），然后再次点击“提出更改”。

    一旦文档达到你想要的方式，点击那个写着“创建 Pull Request”的绿色按钮。这为你提供了再次仔细检查你的更改并确认文档已准备就绪的机会。

  5. 创建 Pull Request

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

    点击那个写着“创建 Pull Request”的大绿色按钮。好消息是，你仍然没有破坏任何东西，因为现在它将交给 RL 文档团队进行审查。

  6. 等待

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

    • 接受并合并你的 PR
    • 评论并提供反馈，并要求更改
    • 拒绝你的 PR 并给出解释

    最后一个响应不太可能。我们真的很想在这里包含你的观点！如果你必须进行更改，你将突然明白为什么你需要一个本地仓库。该团队可以与你沟通下一步该怎么做。好消息是，它仍然可以修复。按照该请求的评论部分查看需要哪些进一步的信息。

    否则，你的请求将被接受并合并。欢迎加入团队，你现在正式成为贡献者！几天后，你会在贡献者指南底部的所有贡献者列表中看到你的名字。

作者：Krista Burdine

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