贡献¶
向 Phalcon 贡献¶
Phalcon 是一个开源项目,严重依赖于志愿者的努力和贡献。我们欢迎每个人的贡献!
请花几分钟时间查看此文档,以了解贡献流程,并使其尽可能高效。通过遵循这些指南,我们可以更快地解决issues,更好地进行沟通,并推动项目向前发展!
Phalcon 的源代码(连同文档、网站等)存储在GitHub. 您可以在我们的组织页面.
如果您希望为 Phalcon 做出贡献,可以通过提交GitHub pull request.
当您创建pull request时,我们会提供一个便捷的模板,帮助您描述pull request的范围。为社区添加测试是非常重要且有帮助的。每个pull request将由核心贡献者(具有合并权限的人)进行审查。根据pull request的类型和内容,可能会:
- 立即合并或
- 暂缓处理,审查者要求更改(样式、测试等)
- 暂缓处理,如果需要讨论(社区、核心团队等)
- 被拒绝
注意
如果您的pull request是一项新功能,最好先与核心团队讨论,以确保它与框架的发展方向一致。
注意
请确保您发送pull request的目标分支是正确的,并且已经重新整理了您的代码。向master分支的pull requests是不允许的
文档¶
如果用 Zephir 编程看起来令人生畏,仍然有很多领域可以做出贡献。您随时可以检查文档中的任何拼写或上下文错误。您还可以通过在相应页面上添加更多示例来增强文档。
您要做的就是访问我们的文档仓库,fork它,进行更改,并向我们发送pull request。
翻译¶
我们已从 v5.5.x 版本开始移除了翻译。社区中没有足够的流量来帮助将文档翻译成不同的语言。
问题和支持¶
Bug 报告检查清单¶
- 在创建GitHub上的问题之前,请确保您使用的是最新发布的Phalcon版本。
- 只会解决在最新发布版本中发现的bug。
- 创建问题时,我们会提供一个便捷的模板,帮助您尽可能多地提供信息,以便核心团队重现并解决问题。能够重现一个bug显著减少了查找原因和修复它的时间。即使是失败的测试脚本也会受到高度赞赏。请查阅如何创建可重现测试页面以获取更多信息。
- 作为您的报告的一部分,请包括其他信息,如操作系统、PHP版本、Phalcon版本、Web服务器、内存等。
- 如果您要提交一个分段错误错误,我们需要回溯信息。请查阅生成调试信息部分以获取更多信息。
生成调试信息¶
有时由于分段错误错误,Phalcon可能会崩溃您的某些Web服务器进程。为了帮助我们找到导致该分段错误的原因,我们需要崩溃回溯信息。
请查阅以下链接以获取生成回溯信息的说明:
Pull Request 检查清单¶
- 向
master
分支发送的pull requests不被接受。请 fork 仓库,并从必要的"source"分支创建您的分支,例如,4.0.x
,如果需要,请在提交pull request前重新整理您的分支。如果有冲突,我们将要求您再次重新整理您的分支。 - 在您的pull request中添加测试或调整现有测试。这非常重要,因为它有助于证明您的pull request。请查阅我们的测试页面以获取有关如何设置测试环境和编写测试的更多信息。
- 由于 Phalcon 是用Zephir编写的,请不要直接提交修改 C 生成文件的提交
- Phalcon 遵循特定的编码风格。请在您最喜欢的 IDE 中安装
editorconfig
插件,以利用随此仓库提供的.editorconfig
文件,而不必担心编码标准。所有测试(PHP 代码)都遵循PSR-12标准 - 在提交pull request之前删除对
ext/kernel
,*.zep.c
和*.zep.h
文件的任何修改 - 更多信息点击这里.
在提交之前新功能,请在GitHub上以新问题的形式打开一个NFR以讨论将该功能或更改包含在核心扩展中的影响。一旦功能获得批准,请确保您的PR包含以下内容:
- 更新到
CHANGELOG.md
- 单元测试
- 文档或使用示例
获取支持¶
如果您有关于如何使用 Phalcon 的任何问题,请参阅支持页面.
请求功能¶
如果您有任何更改或新功能的想法,请填写一份NFR.
谢谢!
<3 Phalcon 团队