译文:初学者必看的开源技巧
共 2111字,需浏览 5分钟
·
2022-02-19 20:32
我是法医,一只治疗系前端码猿🐒,与代码对话,倾听它们心底的呼声,期待着大家的点赞👍与关注➕,当然也欢迎加入前端猎手技术交流群😛,文末扫码我拉你进群,一起交流技术以及代码之外的一切🙆♀️
转载自Duing(ID:duyi-duing)
作者:SHAHED NASSER
如有翻译不准确,请多指正。
作为几个代码库的维护者,我注意到初学者在开源过程中会犯的一些错误以及可能会感到困惑的问题。所以,希望我的这篇文章能给到初学者一些启发和帮助。
而代码库的存在意义在于帮助初学者学习如何为开源做出贡献并给他们机会。
在我作为维护者的这段时间里,我对初学者的问题和困惑有了一个了解,所以我想把他整理出来,放在一篇文章中,希望它可以帮助任何想为开源项目做贡献的初学者。
01
阅读贡献
几乎在每个开源存储库中,您都会找到一个名为 CONTRIBUTING.MD 的文件。该文件将包含对此存储库做出贡献的所有规则、如何进行更改以及如何做出贡献的指南。阅读它非常重要,因为它可以为你节省大量时间来弄清楚你需要做什么,并且可以确保你的拉取请求(或 PR)将遵循项目的所有指南,这将节省时间供维护人员审查并提供要进行的更改。
02
创建一个新的
在为项目做出贡献时,您需要做的第一步是分叉它,以便您可以进行更改并提交它们。但是很多初学者错过的一步是您需要创建一个新分支,不要在分叉后直接对 master 分支进行更改,这对维护者以及整个项目都非常有帮助。
03
处理问题之前
这在一些开源项目中可能有所不同,但我认为它最适用。通常,在为项目做出贡献时,您会转到代码库的问题部分以查看需要哪些帮助。当你发现一个你认为可以解决的问题时,首先确保它是未分配的,然后评论它并要求分配。许多贡献者会忽略问题已分配给其他人的事实,或者忘记对问题发表评论,这会导致在查看解决同一问题的 PR 时感到困惑。为避免这种情况,请先对该问题发表评论,然后获得分配,然后提交您的 PR。
04
在提交PR之前
05
你不需要为每一个变化
我已经看到了很多关于这个的困惑。贡献者会发送一个 PR,我会请求更改,然后贡献者继续关闭 PR 并提交带有请求更改的新 PR,但其实你并不需要这样做。
当你想对 PR 进行更改时,只需进行更改,然后将它们提交到您发送 PR 的存储库。假设您分叉了存储库并创建了一个新分支 patch-1 ,然后在该分支中进行更改、提交并推送你的更改。更改将自动显示在 PR 中。
06
不要提交
我收到的 PR 有的会包含对项目不需要文件的提交,例如你的 IDE 配置文件。但其实,这些是不必要的。所以你在提交更改之前,请先查看发生了哪些更改,并且只提交适用于你正在处理的问题的内容。
07
不要
我最喜欢的贡献者其实是那些搞砸了很多事情的人。原因是,因为他们不断地告诉我他们是新人他们犯了很多错误,因此我就需要不断地要求他们改变。老实说,我认为他们会关闭 PR 并退出。
但他们没有,而是不断地进行尝试,随着时间的推移,他们最后不仅提供了所需的结果,还促成了其他问题的解决。所以,不要害怕犯错,这些错误只会成为你成长的台阶,帮助你取得更多更大地进步。
08
最后的
RECOMMEND
很感谢小伙伴看到最后😘,如果您觉得这篇文章有帮助到您的的话不妨关注➕+点赞👍+收藏📌+评论📜,您的支持就是我更新的最大动力。
欢迎加入前端猎手技术交流群😛,文末扫码加我微信,我拉你进群,一起交流技术以及代码之外的一切🙆♀️