名称

Mojolicious::指南::贡献-贡献给Mojolicous

概述

有很多方法可以帮助Mojolicious公司,本指南将向您展示其中的一些。

PERL基金会BOYCOTT

由于董事会缺乏透明度和问责制,我们抵制Perl基金会。不幸的是,最近有关社区事务团队的事件表明,它并不代表以下价值观开放包含就跟我们现在一样。因此,Mojolicios项目及其核心团队将退出基金会参与和基金会运行活动,我们要求您停止向基金会提供个人捐款,直到基金会进行改革。

我们鼓励Mojolicios社区的成员礼貌但坚定地以他们认为合适的方式倡导相同的价值观,同时不违反Mojolicous行为准则.

报告BUGS

我们使用GitHub问题跟踪器,所以您需要创建一个(免费)GitHub帐户,以便能够提交问题、评论和拉入请求。

首先,请确保您使用的是最新版本的Mojolicious公司,很可能您的错误已经修复。如果这没有帮助,请查看当前未解决问题的列表,可能其他人已经报告过了,您可以添加一条评论来确认。

如果还没有报告,请尝试准备一个测试用例来演示该错误,您不需要自己修复它,但您必须确保开发人员可以复制您的问题。发送整个应用程序通常弊大于利t吨这个发行版的目录中有很多很好的例子来说明如何正确地完成它。编写测试通常是修复错误最困难的部分,因此测试用例越好,修复速度越快。)

创建新问题时,不要忘记添加描述性标题和文本。如果您的问题包含的信息不足或无法理解,它可能会很快关闭。但不要气馁,如果有新的活动,它也会很快重新开放。

报告安全问题

请直接向塞巴斯蒂安·里德尔报告安全问题(kraih@mojolicious.org),并给我们几天时间来开发和发布适当的修复程序。

解决问题

您可以通过多种方式帮助我们解决有关GitHub问题跟踪器.

你能在电脑上重现这个问题吗?添加一条评论,表示您也看到了同样的情况。也许您可以提供额外的信息,使其他人更容易复制问题,甚至可能提供更好的测试用例。

对于所有的代码贡献,我们非常感谢额外的测试和代码审查,只需添加一条注释即可表示您的认可或指出需要解决的缺陷。

贡献文件

最简单的贡献方式之一Mojolicious公司是通过文档改进实现的。Mojolicious::指南由核心团队精心策划,每个拥有(免费)GitHub帐户的人都可以进行更改并向Mojolicious维基.

Pull请求中包含对文档的添加或更改Mojolicious公司分发遵循与代码贡献相同的规则。请不要发送过于简单的更改请求,例如添加逗号或分号。

贡献代码

所有代码贡献都应作为GitHub拉请求。但请尽量避免使用非常简单的更改来请求pull,例如在文档或注释中的某个地方修复了一个拼写错误。

在审查过程中,一个富有表现力的标题和详细的描述是非常宝贵的,通常在社区成员表达了他们的意见并且核心团队审查了变更后,审查过程才会结束。对于合并请求,需要核心团队投票成员的三次积极评价。

所有代码更改都应模仿周围代码的风格,包括没有这些更改而失败的测试,并更新相关文档。

Mojolicious公司发行版涵盖了广泛的功能,我们在添加新功能时相当保守。因此,如果您的贡献不是一个简单的错误修复,那么它是强烈建议你提前在论坛或IRC官方频道#魔力irc.libera.chat(立即聊天!)避免不必要的工作,并增加其被接受的机会。

以下任务声明和规则是所有莫霍Mojolicious公司发展。在发送拉取请求之前,请确保您的贡献与他们一致。

任务说明

莫霍是一个web开发工具包,包含编写简单web应用程序和更高级别web框架所需的所有基本工具和帮助程序,例如Mojolicious公司.

所有组件都应该可以在其他项目中重用,并且只能以UNIXish的方式松耦合。

特别是对于刚接触Perl的人来说,它应该尽可能容易地安装Mojolicious公司开始吧。编写web应用程序是学习语言最有趣的方式之一!

对于其他web框架的开发人员,应该可以重用所有基础设施,只需考虑更高级别的Mojolicious公司分发示例应用程序。

规则

项目的一般规则:

    Web开发应该简单有趣,这就是我们优化的目的。

    网络是一个移动的目标,为了保持相关性,我们也必须保持动态。

    保持简单,除非绝对必要,否则不要施魔法。

    安装过程应该尽可能快速和无痛。(在大多数常见硬件上不到一分钟是一个很好的经验法则)

    它不是没有测试和文档的功能。

    只有当大多数用户从中受益时,才需要功能。

    功能只能在主要版本中更改,以修复严重的安全问题,或者在被弃用至少3个月后才可以更改。

    如果没有实质性好处,则应避免重构和弃用。

    可以将新功能标记为实验性,以便从弃用策略中排除。

    主要版本由新的主要版本号和基于Unicode字符的唯一代码名表示。

    只有在绝对必要时才添加依赖项,并尽可能使其成为可选的。

    模仿现有代码和文档的风格,但如果可以一致地应用,不要害怕采用更新的最佳实践。

    为了支持Perl-ish解决方案,应该避免使用特定于域的语言。

    文档属于指南,模块POD只是一个API参考。

    所包含文档的主要重点应该是示例,而不是文本墙。(每一两句话举一个例子是很好的经验法则)

    如果可能的话,所有的东西都应该按字母顺序排列,否则至少要保持一致。

    主源代码存储库应始终保持稳定状态,使用特性分支进行实际开发。

    必须运行代码Perl::整洁包括珍珠岩,所有的东西都应该看起来像是一个人写的。

    函数和方法应该尽可能短,没有意大利面代码。

    注释应该正确地大写,如果可能的话,应该很有趣,如果标点符号不能提高可读性,可以选择标点符号。

    在之外没有名字莫约利肖.pm.

投票规则

用于项目决策的投票过程:

    当至少3名核心团队成员投票赞成或BDFL否决投票时,可以添加或修改功能。

    任何核心团队成员均可提名新成员,新成员必须以2/3的多数票通过。

    塞巴斯蒂安对所有决定拥有否决权,并将解决无法通过投票决定的问题。

行为准则

就像整个技术社区一样Mojolicious公司团队和社区由来自世界各地的专业人员和志愿者组成,致力于任务的各个方面,包括指导、教学和联系人员。

多样性是我们的巨大优势之一,但它也可能导致沟通问题和不愉快。为此,我们有一些基本规则要求人们遵守。这一准则同样适用于创始人、导师以及寻求帮助和指导的人。

这并不是一份详尽无遗的清单,列出了你无法做到的事情。相反,要本着本意去做,这是一份指南,让我们更容易丰富我们所有人和我们所参与的技术社区。

本行为准则适用于由Mojolicious公司项目。这包括IRC、邮件列表、问题跟踪器以及社区用于交流的项目团队创建的任何其他论坛。此外,在这些空间之外违反本准则可能会影响一个人参与其中的能力。

如果你认为有人违反了行为准则,我们要求你通过电子邮件向乔尔·伯杰举报(jberger@mojolicious.org)或的其他成员团队.

  • 友好、耐心。

  • 热情欢迎。我们努力成为一个欢迎和支持各种背景和身份的人的社区。这包括但不限于任何种族、族裔、文化、民族血统、肤色、移民身份、社会和经济阶层、教育水平、性别、性取向、性别认同和表达、年龄、大小、家庭地位、政治信仰、宗教以及身心能力的成员。

  • 要考虑周到。你的工作会被别人使用,而你反过来又会依赖别人的工作。您所做的任何决定都会影响用户和同事,您在做出决定时应该考虑这些后果。记住,我们是一个世界性的社区,所以你可能不会用其他人的母语进行交流。

  • 尊重他人。并不是所有人都会一直同意,但分歧并不是不良行为和不良举止的借口。我们可能时不时都会遇到一些挫折,但我们不能让这种挫折变成人身攻击。重要的是要记住,人们感到不舒服或受到威胁的社区并不是一个富有成效的社区。的成员Mojolicious公司社区在与其他成员以及社区以外的人打交道时应该相互尊重Mojolicious公司社区。

  • 你选择的单词要小心。我们是一个专业人士的社区,我们的行为很专业。善待他人。不要侮辱或贬低其他参与者。骚扰和其他排斥行为是不可接受的。这包括但不限于:

    • 针对他人的暴力威胁或语言。

    • 歧视性笑话和语言。

    • 发布色情或暴力材料。

    • 发布(或威胁发布)其他人的个人身份信息(“doxing”)。

    • 个人侮辱,尤其是使用种族主义或性别歧视术语的侮辱。

    • 不受欢迎的性关注。

    • 提倡或鼓励上述任何行为。

    • 反复骚扰他人。一般来说,如果有人要求你停下来,那就停下来。

  • 当我们不同意时,试着理解原因。社会和技术上的分歧一直在发生Mojolicious公司也不例外。我们必须建设性地解决分歧和不同观点。记住我们是不同的。的力量Mojolicious公司来自不同的社区,来自不同背景的人。不同的人对问题有不同的观点。无法理解某人为什么持有观点并不意味着他们错了。不要忘记,犯错是人之常情,相互指责并不能让我们取得任何进展。相反,专注于帮助解决问题和从错误中学习。

叉车政策

这个Mojolicious公司核心团队认为,作为一个统一的项目,整个工具包有很多价值。福克斯消耗了项目的资源,不仅是思想共享,还有非常有价值的错误报告和补丁,这可能会带来非常严重的安全影响。所以我们要求你们不要公开叉Mojolicious公司未经我们同意进行分配。由于这样做违背了我们的明确意愿,参与未经授权分叉的个人可能被拒绝参与社区赞助的空间。

对于考虑使用分叉模块的开发人员,我们强烈建议您熟悉其历史记录和跟踪记录。虽然Mojolicious公司过去曾用过叉子,很少有叉子能跟上Mojolicious公司开发,大多数都缺少关键的错误修复。

更多

您可以继续Mojolicious::指南现在或者看看Mojolicious维基,其中包含了许多不同作者的更多文档和示例。

支持

如果您有任何文档可能还没有回答的问题,请毫不犹豫地在论坛,上的IRC公司,或矩阵.