贡献指南
错误报告
为了鼓励积极的协作,Laravel 强烈鼓励提交拉取请求,而不仅仅是错误报告。“错误报告”也可以以包含失败测试的拉取请求的形式发送。
然而,如果您提交错误报告,您的问题应包含标题和问题的清晰描述。您还应尽可能多地包含相关信息和演示问题的代码示例。错误报告的目标是让自己和他人能够轻松地重现错误并开发修复方案。
请记住,错误报告是为了希望有相同问题的其他人能够与您合作解决问题。不要期望错误报告会自动看到任何活动或其他人会立即修复它。创建错误报告是为了帮助自己和他人开始解决问题的路径。如果您想参与,您可以通过修复我们问题跟踪器中列出的任何错误来提供帮助。
Laravel 源代码在 GitHub 上管理,并且每个 Laravel 项目都有相应的仓库:
支持问题
Laravel 的 GitHub 问题跟踪器并不是为了提供 Laravel 帮助或支持。相反,请使用以下渠道之一:
核心开发讨论
您可以在 Laravel Ideas 问题板上提出新功能或改进现有 Laravel 行为的建议。如果您提出新功能,请愿意实现至少部分完成该功能所需的代码。
关于错误、新功能和现有功能实现的非正式讨论在 Laravel Discord 服务器的 #internals
频道进行。Laravel 的维护者 Taylor Otwell 通常在工作日的 8am-5pm(UTC-06:00 或美国/芝加哥)在频道中出现,并在其他时间不定期出现。
哪个分支?
所有错误修复应发送到最新的稳定分支或当前 LTS 分支。错误修复绝不应发送到 master
分支,除非它们修复的功能仅存在于即将发布的版本中。
完全向后兼容当前版本的小功能可以发送到最新的稳定分支。
重大新功能应始终发送到 master
分支,该分支包含即将发布的版本。
如果您不确定您的功能是重大还是小功能,请在 Laravel Discord 服务器的 #internals
频道中询问 Taylor Otwell。
编译后的资源
如果您提交的更改会影响编译文件,例如 laravel/laravel
仓库中的大多数 resources/sass
或 resources/js
文件,请不要提交编译文件。由于它们的体积较大,维护者无法实际审查。这可能被利用为向 Laravel 注入恶意代码的一种方式。为了防止这种情况,所有编译文件将由 Laravel 维护者生成和提交。
安全漏洞
如果您发现 Laravel 中的安全漏洞,请发送电子邮件至 Taylor Otwell taylor@laravel.com。所有安全漏洞将被及时处理。
编码风格
Laravel 遵循 PSR-2 编码标准和 PSR-4 自动加载标准。
PHPDoc
以下是一个有效的 Laravel 文档块示例。请注意,@param
属性后跟两个空格、参数类型、再两个空格,最后是变量名:
/**
* 在容器中注册绑定。
*
* @param string|array $abstract
* @param \Closure|string|null $concrete
* @param bool $shared
* @return void
*
* @throws \Exception
*/
public function bind($abstract, $concrete = null, $shared = false)
{
//
}
StyleCI
如果您的代码风格不完美,不用担心!StyleCI 会在拉取请求合并后自动将任何样式修复合并到 Laravel 仓库中。这使我们能够专注于贡献的内容而不是代码风格。
行为准则
Laravel 的行为准则源自 Ruby 的行为准则。任何违反行为准则的行为都可以报告给 Taylor Otwell (taylor@laravel.com):
- 参与者将容忍相反的观点。
- 参与者必须确保他们的语言和行为没有人身攻击和贬低的个人言论。
- 在解释他人的言行时,参与者应始终假设良好的意图。
- 任何可以合理认为是骚扰的行为都不会被容忍。