首次通过 CLI 贡献 Rocky Linux 文档
简介¶
本 Gemstone 详细介绍了如何仅使用命令行界面 (CLI) 为 Rocky Linux 文档项目做出贡献。它涵盖了首次 fork 存储库和创建 pull request。在我们的示例中,我们将贡献一个新的 Gemstone 文档。
问题描述¶
贡献者可能希望或需要通过 CLI 执行所有操作,从 fork 存储库到首次提交 pull request。
先决条件¶
- 一个 GitHub 账户
- 您的系统上安装了
git
和GitHub CLI (gh)
- 已准备好贡献的 markdown 文件
解决方案步骤¶
- 使用 GitHub CLI Fork 存储库:将上游存储库 fork 到您的账户。
gh repo fork https://github.com/rocky-linux/documentation --clone
- 导航到存储库目录:
cd documentation
- 添加上游存储库:
git remote add upstream https://github.com/rocky-linux/documentation.git
- 创建新分支:为您的贡献创建一个新分支。输入
git checkout -b new-gemstone
-
添加新文档:使用您喜欢的文本编辑器创建和编辑您的新贡献文件。在此示例中,我们将创建一个名为
gemstome_new_pr.md
的新文件,并将其保存在docs/gemstones/
目录下。 -
提交更改:暂存并提交您的新文件。输入
git add docs/gemstones/gemstome_new_pr.md
git commit -m "Add new Gemstone document"
- 推送到您的 Fork:将更改推送到您的 Rocky Linux 文档 repo 的 fork/副本。输入
git push origin new-gemstone
- 创建 Pull Request:向 the upstream repository 创建一个 pull request。
gh pr create --base main --head wsoyinka:new-gemstone --title "New Gemstone: Creating PRs via CLI" --body "Guide on how to contribute to documentation using CLI"
其他信息(可选)¶
- 使用
gh pr list
和gh pr status
来跟踪您的 pull request 的状态。 - 查看并遵循 Rocky Linux 文档项目的贡献指南。
结论¶
遵循这些步骤,您应该能够成功创建您的第一个 PR,并完全通过 CLI 为 Rocky Linux 文档存储库做出贡献!
作者:Wale Soyinka