Laravel 10.x 中文文档

简体中文

English

简体中文

English

主题

贡献指南 ​

错误报告 ​

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

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

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

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

Laravel 源代码在 GitHub 上管理，并且每个 Laravel 项目都有相应的仓库：

支持问题 ​

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

核心开发讨论 ​

您可以在 Laravel 框架仓库的 GitHub 讨论板中提出新功能或改进现有 Laravel 行为的建议。如果您提出新功能，请愿意实现至少部分完成该功能所需的代码。

关于错误、新功能和现有功能实现的非正式讨论在 Laravel Discord 服务器的 #internals 频道中进行。Laravel 的维护者 Taylor Otwell 通常在工作日的 8am-5pm（UTC-06:00 或美国/芝加哥）在频道中出现，并在其他时间不定期出现。

哪个分支？ ​

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

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

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

编译后的资源 ​

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

安全漏洞 ​

如果您发现 Laravel 中的安全漏洞，请发送电子邮件至 Taylor Otwell taylor@laravel.com。所有安全漏洞将被及时处理。

编码风格 ​

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

PHPDoc ​

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

php
/**
 * 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 属性由于使用本地类型而显得多余时，可以将其删除：

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

然而，当本地类型是泛型时，请通过使用 @param 或 @return 属性指定泛型类型：

php
/**
 * 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 会在 pull 请求合并后自动将任何样式修复合并到 Laravel 仓库中。这使我们能够专注于贡献的内容而不是代码风格。

行为准则 ​

Laravel 的行为准则源自 Ruby 的行为准则。任何违反行为准则的行为都可以报告给 Taylor Otwell (taylor@laravel.com)：

  • 参与者将容忍相反的观点。
  • 参与者必须确保他们的语言和行为没有人身攻击和贬低的个人言论。
  • 在解释他人的言行时，参与者应始终假定良好的意图。
  • 任何可以合理认为是骚扰的行为都不会被容忍。

版权所有 © 2024-2025 laravel.wiki