通过 CLI 首次为 Rocky Linux 文档做出贡献
简介¶
这颗宝石详细介绍了如何仅使用命令行界面 (CLI) 为 Rocky Linux 文档项目做出贡献。它涵盖了首次分叉存储库并创建拉取请求。我们将以贡献新的 Gemstone 文档为例。
问题描述¶
贡献者可能更喜欢或需要通过 CLI 执行所有操作,从分叉存储库到首次提交拉取请求。
先决条件¶
- GitHub 帐户
git
和GitHub CLI (gh)
已安装在您的系统上- 准备好的 Markdown 文件,用于贡献
解决方案步骤¶
- 使用 GitHub CLI 分叉存储库:将上游存储库分叉到您的帐户。
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 文档存储库副本。键入
git push origin new-gemstone
- 创建拉取请求:向上游存储库创建拉取请求。
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
跟踪拉取请求的状态。 - 查看并遵循 Rocky Linux 文档项目的贡献指南。
结论¶
按照这些步骤,您应该能够成功创建您的第一个 PR 并完全通过 CLI 为 Rocky Linux 文档存储库做出贡献!
作者:Wale Soyinka