Contribution Guide

• Bug Reports
• Support Questions
• Which Branch?
• Compiled Assets
• AI-Generated Contributions
• Security Vulnerabilities
• Coding Style
  • PHPDoc
  • StyleCI
• Code of Conduct

Bug Reports

To encourage active collaboration, Laravel strongly encourages pull requests that address problems, not GitHub issues. GitHub issues are disabled on most of our first-party packages.

If you discover a problem, please create a pull request that addresses the problem. Your pull request should contain a title and a clear description of the problem and its solution. You should also include as much relevant information as possible and a code sample that demonstrates the issue. The goal of a pull request is to make it easy for yourself - and others - to understand the problem and verify the fix.

If you do not know how to fix the problem, describe the issue to a coding agent and use it to attempt a pull request.

Pull requests will only be reviewed when marked as "ready for review" (not in the "draft" state) and all tests for new features are passing. Lingering, non-active pull requests left in the "draft" state will be closed after a few days.

The Laravel source code is managed on GitHub, and there are repositories for each of the Laravel projects:

Support Questions

Laravel's GitHub issue trackers are not intended to provide Laravel help or support. Instead, use one of the following channels:

Which Branch?

All bug fixes should be sent to the latest version that supports bug fixes (currently 13.x). Bug fixes should never be sent to the master branch unless they fix features that exist only in the upcoming release.

Minor features that are fully backward compatible with the current release may be sent to the latest stable branch (currently 13.x).

Major new features or features with breaking changes should always be sent to the master branch, which contains the upcoming release.

Compiled Assets

If you are submitting a change that will affect a compiled file, such as most of the files in resources/css or resources/js of the laravel/laravel repository, do not commit the compiled files. Due to their large size, they cannot realistically be reviewed by a maintainer. This could be exploited as a way to inject malicious code into Laravel. In order to defensively prevent this, all compiled files will be generated and committed by Laravel maintainers.

AI-Generated Contributions

We appreciate every pull request submitted to Laravel. However, substantial contributions that are primarily AI-generated without thoughtful human review and consideration are not acceptable.

If you choose to use AI tools to assist with large or complex contributions to the framework, the resulting code must be thoroughly reviewed, tested, and understood by you before submitting.

Pull request descriptions must be written entirely by the contributor. Pull requests with AI-generated descriptions will be closed.

Mass opening issues or pull requests that are entirely AI-generated will not be tolerated. Such pull requests will be closed without review, and the contributing user may be blocked from the repository.

We encourage contributors to familiarize themselves with the existing codebase, engage with the community, and submit pull requests that reflect their own understanding and careful consideration of the problem they are solving.

Security Vulnerabilities

If you discover a security vulnerability within Laravel, please email our security team at [email protected]. All security vulnerabilities will be promptly addressed.

Coding Style

Laravel follows the PSR-2 coding standard and the PSR-4 autoloading standard.

PHPDoc

Below is an example of a valid Laravel documentation block. Note that the @param attribute is followed by two spaces, the argument type, two more spaces, and finally the variable name:

 1/**
 2 * Register a binding with the container.
 3 *
 4 * @param  string|array  $abstract
 5 * @param  \Closure|string|null  $concrete
 6 * @param  bool  $shared
 7 * @return void
 8 *
 9 * @throws \Exception
10 */
11public function bind($abstract, $concrete = null, $shared = false)
12{
13    // ...
14}

When the @param or @return attributes are redundant due to the use of native types, they can be removed:

1/**
2 * Execute the job.
3 * 
4 
5 */
6public function handle(AudioProcessor $processor): void
7{
8    // ...
9}

However, when the native type is generic, please specify the generic type through the use of the @param or @return attributes:

 1/**
 2 * Get the attachments for the message.
 3 * 
 4 * @return array<int, \Illuminate\Mail\Mailables\Attachment> 
 5 */
 6public function attachments(): array
 7{
 8    return [
 9        Attachment::fromStorage('/path/to/file'),
10    ];
11}

StyleCI

Don't worry if your code styling isn't perfect! StyleCI will automatically merge any style fixes into the Laravel repository after pull requests are merged. This allows us to focus on the content of the contribution and not the code style.

Code of Conduct

The Laravel code of conduct is derived from the Ruby code of conduct. Any violations of the code of conduct may be reported to Taylor Otwell ([email protected]):