其他贡献

未匹配的标注

如何贡献

介绍

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

这不是一个详尽的列表,也不是唯一的贡献方式,但它们是最常见的。如果你知道其他参与贡献方式,请告诉我们。

为开发做出贡献

当然,该项目需要对主要开发方面做出贡献,但这不是唯一的方式。但是,如果你想为开发做出贡献,那么一个很好的入门方法就是简单地阅读本文档。熟悉框架的工作原理,Controllers(控制器)Routing(路由) 的工作原理,并从请求生命周期开始阅读架构概念相关文档,然后Service Providers(服务提供者) 最后是 Service Container(服务容器)。阅读 Release Cycle(版本发布计划) 以熟悉 Masonite 如何发布(SemVer 和 RomVer)也很不错。

成为特性维护者

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

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

代码评论或注释

如果你不想接触代码而只想查看并弄清楚,请提供一些评论!注释是未来开发人员阅读和理解框架的绝佳方式。 Masonite 力求获得极高的评价。虽然大部分代码本身不需要注释,但一些类、模块、方法和函数需要注释(尽管其中很多已经有相应注释了)。

注释不会影响工作代码,所以如果你想习惯于为开源做贡献,或者你只是不太了解类方法在做什么,或者你害怕贡献和破坏项目(其实现在已经有测试的方法避免这个问题了),那么发表评论非常适合你!

编写测试

Masonite 的包 需要测试。如果你想搜索这些存储库的测试目录中的所有测试并编写其他测试和用例,那将是非常棒的!已经有超过 100 个测试,但你总是可以写更多。更多的测试带来更多的稳定性。特别是当人们开始为项目做出贡献时。检查已经存在的测试并编写任何缺少的用例。这些测试可以是诸如 url 中的特殊字符之类的东西,也可以是在为该功能使用 TDD 时可能没有想到的其他奇怪的东西。

参与教程制作

一旦熟悉了项目(通过贡献或使用框架构建应用程序),如果那你可以编写或录制教程并将它们放在 Medium 或 [YouTube](http ://youtube.com)。为了使框架成功,即使在本文档之外,它也需要有大量的文档。它需要声名狼藉,如果人们看到该框架出现在他们最喜欢的位置,他们将更倾向于使用该框架并为其做出贡献。

此外,还会有很棒的教程供初学者查找和观看,你还可以在 Masonite 的背后建立一个追随者。

修复/更正文档

我们的文档非常棒,但有些地方还可以改进。也许我们没有完全解释某些内容,或者某些内容对你来说没有意义。 Masonite 使用 Gitbook.com 来托管它的文档,这样你就可以直接对文档发表评论,这将开始你和文档合作者之间的讨论。因此,如果你想逐页浏览文档并熟悉框架但同时为文档做出贡献,那么这对你来说是完美的。

报告缺陷(Bug)

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

认领或参与 Bugs 修复(讨论)

查看 GitHub.com 上的问题页面,了解你愿意修复的任何问题、错误或增强功能。如果你不知道如何处理它们,只需对问题发表评论,Joseph Mancuso 或其他核心贡献者将非常乐意逐步解释如何解决或开发该问题。

建立社区

如果你在任何社交媒体上拥有大量粉丝或你还在一个默默无名的阶段,你可以通过尝试围绕 Masonite 建立追随者来做出贡献。任何开源项目都需要一个围绕框架的活跃社区。你可以亲自建立一个社区并成为该社区的领导者,也可以简单地将他们发送到 Masonite 的 GitHub 存储库,我们可以在那里建立一个社区。

围绕 Masonite 构建社区软件

另一个想法是使用 Masonite 构建应用程序,例如像 LaraCasts.com 这样的教程网站或 Masonite 官方网站,甚至是围绕 Masonite 的社交网络。每个伟大的框架都需要它的「生态系统」,因此通过使用 Masonite 品牌和徽标构建这些应用程序,你可能会成为其中的一员。尽管复制品牌需要 Joseph Mancuso 的同意,但只要网站是用 Masonite 构建的并且看起来很干净,那根本不成问题。

回答来自社区的问题

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

审查 PR 中的代码

大多数拉取请求将在 GitHub 中停留几天,同时进行质量测试。主要的「开发」分支拉取请求可能会在那里停留长达 6 个月,并且只会在发布时合并。话虽如此,你可以查看这些拉取请求的文件更改并确保它们符合社区准则,API 类似于项目的其他方面,并且他们尊重并遵循拉取请求规则,符合 贡献指南 文档。

讨论问题

在问题或拉取请求上时不时会出现「需要讨论」标签。如果你看到此标签,请务必添加你对某个问题的看法。所有问题都开放供讨论,Masonite 竭力听取开发人员的意见,因此请随时参与讨论。

创建包

每个框架都需要出色的包,而作为 Masonite 的维护者,我们只能在提供出色的包并同时维护框架方面做很多事情。我们期待着我们的社区为 Masonite 生态系统带来精彩的补充。如果您有任何问题,请务必在 Github 主页上的 gitter 聊天室中提出。

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

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

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

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

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


暂无话题~