参与开源项目的6个建议
hello,各位小伙伴,本文主要介绍如何区参与开源项目。为开源项目做贡献与我们日常开发有很大的不同。当你为开源项目做出贡献时,你所在的团队可能由来自世界各地的数百甚至数千人组成。为了更好的与队友进行合作,你需要学习如何使用Git和GitHub,并且你必须要知道如何提交一个PR。了解提交PR时应该遵守的规则同样重要!
1. 阅读Readme.md
所有的开源项目都有编写良好的文档,包括:项目 README、项目的贡献指南以及新贡献者的其他附加信息。
对于新的贡献者来说,正确阅读所有这些文档非常重要。这些文档包括重要信息,例如如何在本地系统上使用项目、如何提出问题、贡献时要遵循的指南、贡献者可以在哪里寻求帮助等。
所以不要偷懒,在开始贡献之前一定要阅读这些文档。
2. 了解项目
在为项目做出贡献之前,了解项目对我们来说很重要。我们很难理解整个项目,我们也不必了解项目的每一个件事都做了什么。我们只需要了解项目!
我们可以将项目pull到本地,并运行以便对项目有一个整体的了解。
3. 提出问题
如果你想开发一个新功能,或者你在项目中遇到了一个新的错误,不要立即开始着手处理它。首先,提出一个问题并正确定义您的功能/错误,当该项目的维护者分配给您该问题或给您一个绿色信号时,您就可以开始了。
对于预先存在的问题: 你还应该记住检查与你要创建的问题相同的问题是否已经存在。如果存在,则不要创建相同错误/功能的多个问题。您可以对已经存在的问题发表评论,并询问维护者是否可以开始处理它。如果没有其他人在处理它,维护者将分配给您该问题。
4. 定义你的 PR
现在你已经做出了你想要的更改,是时候创建拉取请求了。在你的 PR 消息中定义你的 PR,告诉其他人做了哪些更改,为什么要进行这些更改,以及任何其他有助于维护人员更好地了解 PR 的相关信息。
5.保持简单
在创建 PR 之前,您还应该记住一件事。
你应该尽量让你的 PR 尽可能简单。不要在单个 PR 中进行多项更改。
我自己维护了一个开源项目,我知道当人们在一个 PR 中进行大量更改时,审查 PR 是多么困难。不要那样做,如果您要更改/添加多个内容,请创建单独的 PR。表明你关心你的维护者,不要让他/她的工作变得更加困难。
6.沟通和寻求帮助
开源社区非常欢迎新手。如果你在贡献时遇到任何问题,你可以随时寻求帮助。你可以通过评论您正在处理的问题或通过讨论选项卡来寻求帮助。
但是,在与社区交流时,您应该牢记以下几点:
- 始终保持礼貌。
- 不要只说“嗨”,问你的问题。
- 保持简短和重点。每个人的时间都是宝贵的。
- 请耐心等待,您会得到答复,您的问题将得到解决。
- 不要垃圾邮件。
- 不要标记任何人。
- 遵守组织的社区准则。
- 点赞
- 收藏
- 关注作者
评论(0)