如何贡献

未匹配的标注
本文档最新版为 4.0,旧版本可能放弃维护,推荐阅读最新版!

如何贡献

介绍

有很多方法可以为开源做出贡献。其中许多甚至都不依赖于编写代码。一个伟大的开源项目应拥有出色的文档,繁荣的社区并尽可能减少错误。下面,我将解释如何以不同的方式为该项目做出贡献,包括和不包括代码贡献。

这不是详尽的清单,也不是唯一的贡献方式,但它们是最常见的方式。如果您知道其他贡献方式,请告诉我们。

促进发展

当然,该项目需要对主要开发方面做出贡献,但这不是唯一的方法。但是,如果您想为开发做出贡献,那么入门的一个好方法就是简单地阅读本文档。熟悉框架的工作原理,控制器路由 的工作原理,并阅读 程序架构 文档,从 请求周期 开始,然后是 服务提供者,最后是 服务容器

最好阅读 Release Cycle,以熟悉 Masonite 如何发布 (SemVer 和 RomVer)。

成为功能维护者

功能维护者是负责特定功能 (例如 缓存系统创建扩展包) 的人员。这些开发人员将负责审查PR,并将其合并到开发分支中,并直接与存储库所有者联系以进行讨论。

功能维护者必须已经为他们要成为功能维护者的存储库的开发做出了重要贡献。尽管他们不必为计划维护的实际功能做出贡献。

注释代码

如果你不想接触代码,而只想查看并找出它,请贡献一些评论!注释是未来开发人员阅读和理解框架的一种很好的方式。Masonite 努力获得极大的评论。虽然大多数代码本身不需要注释,但有些类、模块、方法和函数确实需要注释(尽管其中很多已经有注释)。

注释不会影响工作代码,因此如果您想习惯于为开放源码做贡献,或者只是不太理解类方法在做什么,或者您害怕贡献和破坏项目(有测试),那么贡献注释是适合您的!

写测试

Masonite pip packages需要测试(主库不需要)。如果您想要搜索那些存储库的测试目录中的所有测试,并编写额外的测试和用例,那么这将是很好的!已经有 100 多个测试了,但是你还可以写更多。测试越多,稳定性就越好。特别是当人们开始为这个项目做出贡献的时候。检查已经存在的测试,并编写任何缺少的用例。这些测试可以是URL中的特殊字符或使用 TDD 用于该功能时可能没有考虑到的其他奇怪之处。

贡献教程

一旦熟悉了项目(通过使用框架来或通过构建应用程序),如果您可以编写或记录教程并将其放在 MediumYouTube 上,那将是很好的选择。为了使框架成功,即使在本文档之外,也需要大量的文档。它需要为人所知,如果人们看到框架在自己喜欢的位置弹出,他们将更倾向于使用该框架并做出贡献。

另外,这里还有许多很棒的教程供初学者查找和观看,您还可以在 Masonite 的背后建立一个后续站点。

修复文档

该文档很棒,但是有一些地方可以改进。也许我们还没有完全解释某些事情,或者对您来说没有什么意义。 Masonite 使用 Gitbook.com 来托管其文档,并可以直接在文档上发表评论,这将在您和文档合作者之间展开讨论。因此,如果您想逐页浏览文档并熟悉框架,但同时又对文档有所贡献,那么这对您来说是完美的。

报告错误

如果您只是不想为主项目贡献代码,则可以只报告错误或改进。您可以继续像往常一样构建任何应用程序,并将遇到的任何错误报告给 GitHub.com 问题页面。

解决错误

请查看 GitHub.com 上的问题页面,以获取您愿意解决的任何问题,错误或增强功能。如果您不知道如何处理这些问题,只需对问题发表评论,约瑟夫·曼库索(Joseph Mancuso)或其他核心贡献者将很乐于一步一步地说明如何解决或发展该问题。

建立社区

如果您在其他社交媒体上有大量关注者,则可以通过在 Masonite 周围建立关注来做出贡献。任何开源项目都需要围绕框架的惊人社区。若您没有关注者,您可以亲自建立一个社区并成为该社区的领导者,也可以将它们发送到 Masonite 的 GitHub 存储库中,在该存储库中我们可以在附近建立一个社区。

围绕 Masonite 构建社区软件

另一个想法是使用 Masonite 构建应用程序,例如 LaraCasts.com 之类的截屏网站,Masonite 官方网站或围绕 Masonite 的社交网络。每个出色的框架都需要它的「生态系统」,因此,通过使用 Masonite 品牌和徽标构建这些应用程序,您可能会与众不同。尽管复制商标需要 Joseph Mancuso 同意,但只要该网站是使用 Masonite 构建的并且看上去很干净,那根本就不是问题。

回答社区的问题

问题最终将通过 GitHub 问题或通过 StackOverflow 之类的网站出现。您可以将第一个回答这些人的问题作为优先选项,或者,如果您不知道答案,可以将一个核心维护者或贡献者重定向到该问题,以便我们进一步回答。

查看请求代码

经过质量测试后,大多数拉取请求将在GitHub中放置几天。 主要的develop分支拉取请求可以在那里放置长达6个月,并且只会在发行版中合并。 话虽如此,您可以查看这些拉取请求的文件更改,并确保它们符合社区准则,API与项目的其他方面类似,并且它们受到尊重,并遵循 贡献指南文档。

问题讨论

时不时会有一个关于问题或请求的requires discussion标签。 如果看到此标签,请务必添加您对问题的想法。 所有问题都可以讨论,Masonite会尽量避免开发人员的投入,因此可以随时进行讨论。

创建软件包

每个框架都需要优秀的软件包,而作为Masonite的维护者,我们只能提供出色的软件包并同时维护框架。 我们期待社区为Masonite生态系统带来很棒的添加。 如果您有任何问题,请打开Github主页上的gitter聊天室。

本文章首发在 LearnKu.com 网站上。

本译文仅用于学习和交流目的,转载请务必注明文章译者、出处、和本文链接
我们的翻译工作遵照 CC 协议,如果我们的工作有侵犯到您的权益,请及时联系我们。

原文地址:https://learnku.com/docs/masonite/2.3/pr...

译文地址:https://learnku.com/docs/masonite/2.3/pr...

上一篇 下一篇
贡献者:6
讨论数量: 0
发起讨论 只看当前版本


暂无话题~