对开源代码进行更改可能会令人兴奋。
最近,我正在开发一个软件,为用户提供一个控制台命令行界面,以便与 HPE 的 Operations Orchestration 产品的 NodeJS API 客户端 进行交互。我意识到我需要使用别人编写的一个库来解析所有的参数,并显示一个友好的命令使用输出。就像这样
我开始在 npm 中搜索一个要使用的库,npm 是最大的开源 NodeJS 包存储库。在 npm 中最流行的库之一是 command-line-args。我试了一下,发现它几乎拥有我需要的一切,包括测试和代码覆盖率。它也得到了很好的维护,经常发布版本。然后,我遇到了一个问题。我想在我的命令参数中添加一些描述,但是在文档中找不到任何关于它的信息。在进一步检查源代码后,我发现可以配置一个描述属性。
太好了,对吧?我找到了解决问题的方法,我完成了。
嗯,不完全是。如果将来其他人也遇到同样的问题怎么办?他们可能无法找到解决方案,并且因为这个库似乎不支持描述配置而排除它。当我们将事情传递下去时,开源软件才能发挥最佳效果,所以当你发现有可以改进的地方时,请采取下一步措施来自己改进它。
在 GitHub 上提交 pull request 的 3 个简单步骤
1. 通过 Fork 原始代码库来创建你自己的代码副本。
登录到 GitHub 并浏览该项目的代码库页面时,找到并单击页面右上角的 Fork 按钮。你的新个人代码库将被创建。
此时,你可以对它进行任何修改,并向你 Fork 的父代码库提出建议。你可以在你自己的计算机上克隆这个新的 Fork 代码库,或者通过 GitHub UI 编辑文件。
如果你没有首选的 Git UI 工具,但确实安装了 Git,则以下命令会将代码库克隆到本地目录
git clone
2. 在新的 Fork 代码库中更改所需的文件。
如果你想对 README 文件等内容进行简单的更改,你可以很容易地从 GitHub 的网站上进行编辑。要这样做,找到你要编辑的文件,点击它来查看。然后,找到右上角的 笔形图标 以在浏览器中编辑文件。进行任何你希望的更改,添加提交消息,然后点击 Commit。
如果你需要在本地克隆的代码库中修改文件,那么在完成更改后,不要忘记提交文件
git add .
git commit -m "a commit message"
然后将更改推送到你在 GitHub 上的远程代码库
git push origin
3. 创建一个 pull request,将你的更改合并并整合到原始代码库中。
创建 pull request 允许上游代码库(你 Fork 的原始项目)接受你对改进和修复的建议。
要创建一个新的 pull request,只需在你代码库的项目页面上找到一个名为 New pull request 的绿色按钮,你将看到你在个人 Fork 代码库中所做的更改列表。在 pull request 的顶部,基本项目是你 Fork 的上游代码库。该页面将显示每个文件的完整更改列表(差异),你可以查看。要继续,点击绿色的 Create pull request 按钮并确认标题和描述。然后提交它,你就完成了!
你的贡献将被发送给项目维护者。
我应该指出,维护者可能会因为很多原因选择不采纳你的贡献,包括代码风格标准和提交消息准则。也可能该项目不再被积极维护,你将不会得到维护者的关注。因此,最好查阅项目中常见的文件,名为 CONTRIBUTING.md,其中提供了如何将代码贡献回项目的指南。当然,你还需要确保该项目仍在维护,并且准备好接受贡献。
你提交更改到开源代码库的经验是什么? 你有什么建议要给出吗?请在评论中告诉我们。
2 条评论