贡献指南

• 错误报告
• 支持问题
• 核心开发讨论
• 哪个分支？
• 编译的资源
• 安全漏洞
• 编码风格
  • PHPDoc
  • StyleCI
• 行为准则

错误报告

为了鼓励积极协作，Laravel 强烈建议提交拉取请求，而不仅仅是错误报告。只有在标记为“准备好审查”（而不是处于“草稿”状态）并且新功能的所有测试都通过时，才会审查拉取请求。在“草稿”状态下遗留的、不活跃的拉取请求将在几天后关闭。

但是，如果你提交错误报告，你的问题应该包含标题和对问题的清晰描述。你还应该包含尽可能多的相关信息和演示问题的代码示例。错误报告的目标是让你自己和其他人轻松复制错误并开发修复程序。

请记住，创建错误报告是为了希望其他遇到相同问题的人能够与你合作解决问题。不要期望错误报告会自动看到任何活动或其他人会跳出来修复它。创建错误报告有助于你和其他人开始解决问题的道路。如果你想参与其中，你可以通过修复 在我们的问题跟踪器中列出的任何错误 来提供帮助。你必须使用 GitHub 身份验证才能查看 Laravel 的所有问题。

如果你在使用 Laravel 时注意到不正确的 DocBlock、PHPStan 或 IDE 警告，请不要创建 GitHub 问题。相反，请提交拉取请求来修复问题。

Laravel 源代码在 GitHub 上进行管理，每个 Laravel 项目都有一个存储库

支持问题

Laravel 的 GitHub 问题跟踪器不用于提供 Laravel 帮助或支持。请改用以下渠道之一

核心开发讨论

你可以在 Laravel 框架存储库的 GitHub 讨论区中提出新功能或改进现有 Laravel 行为的建议。如果你提出新功能，请愿意实现至少一些完成该功能所需的代码。

关于错误、新功能以及现有功能实现的非正式讨论在 Laravel Discord 服务器的 #internals 频道中进行。Laravel 的维护者 Taylor Otwell 通常在工作日的上午 8 点至下午 5 点（UTC-06:00 或美洲/芝加哥）在频道中出现，偶尔在其他时间出现在频道中。

哪个分支？

所有错误修复应发送到支持错误修复的最新版本（目前为 11.x）。错误修复绝不应发送到 master 分支，除非它们修复了仅在即将发布的版本中存在的功能。

与当前版本完全向后兼容的次要功能可以发送到最新的稳定分支（目前为 11.x）。

主要新功能或具有重大更改的功能应始终发送到包含即将发布的版本的 master 分支。

编译的资源

如果你提交的更改会影响编译后的文件，例如 laravel/laravel 存储库中 resources/css 或 resources/js 中的大多数文件，请不要提交编译后的文件。由于它们的大小很大，维护人员无法实际审查它们。这可以被利用作为将恶意代码注入 Laravel 的一种方式。为了防御性地防止这种情况，所有编译后的文件将由 Laravel 维护人员生成和提交。

安全漏洞

如果你在 Laravel 中发现安全漏洞，请发送电子邮件给 Taylor Otwell，地址为 [email protected]。所有安全漏洞都将得到及时解决。

编码风格

Laravel 遵循 PSR-2 编码标准和 PSR-4 自动加载标准。

PHPDoc

以下是有效的 Laravel 文档块示例。请注意，@param 属性后跟两个空格、参数类型、另外两个空格，最后是变量名

/**
 * Register a binding with the container.
 *
 * @param  string|array  $abstract
 * @param  \Closure|string|null  $concrete
 * @param  bool  $shared
 * @return void
 *
 * @throws \Exception
 */
public function bind($abstract, $concrete = null, $shared = false)
{
    // ...
}

当由于使用原生类型而导致 @param 或 @return 属性冗余时，可以删除它们

/**
 * Execute the job.
 */
public function handle(AudioProcessor $processor): void
{
    //
}

但是，当原生类型是泛型时，请使用 @param 或 @return 属性指定泛型类型

/**
 * Get the attachments for the message.
 *
 * @return array<int, \Illuminate\Mail\Mailables\Attachment>
 */
public function attachments(): array
{
    return [
        Attachment::fromStorage('/path/to/file'),
    ];
}

StyleCI

如果你的代码样式不完美，请不要担心！在合并拉取请求后，StyleCI 会自动将任何样式修复合并到 Laravel 存储库中。这使我们可以专注于贡献的内容，而不是代码样式。

行为准则

Laravel 的行为准则源自 Ruby 的行为准则。任何违反行为准则的行为都可以报告给 Taylor Otwell ([email protected])