-
Notifications
You must be signed in to change notification settings - Fork 4.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
New translations contributions.md (Spanish)
- Loading branch information
1 parent
6500bbd
commit b013af8
Showing
1 changed file
with
126 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,126 @@ | ||
# Contribution Guide | ||
|
||
- [Bug Reports](#bug-reports) | ||
- [Core Development Discussion](#core-development-discussion) | ||
- [Which Branch?](#which-branch) | ||
- [Security Vulnerabilities](#security-vulnerabilities) | ||
- [Coding Style](#coding-style) | ||
- [PHPDoc](#phpdoc) | ||
- [StyleCI](#styleci) | ||
|
||
<a name="bug-reports"></a> | ||
|
||
## Bug Reports | ||
|
||
To encourage active collaboration, Laravel strongly encourages pull requests, not just bug reports. "Bug reports" may also be sent in the form of a pull request containing a failing test. | ||
|
||
However, if you file a bug report, your issue should contain a title and a clear description of the issue. You should also include as much relevant information as possible and a code sample that demonstrates the issue. The goal of a bug report is to make it easy for yourself - and others - to replicate the bug and develop a fix. | ||
|
||
Remember, bug reports are created in the hope that others with the same problem will be able to collaborate with you on solving it. Do not expect that the bug report will automatically see any activity or that others will jump to fix it. Creating a bug report serves to help yourself and others start on the path of fixing the problem. | ||
|
||
The Laravel source code is managed on GitHub, and there are repositories for each of the Laravel projects: | ||
|
||
<div class="content-list"> | ||
<ul> | ||
<li> | ||
<a href="https://github.com/laravel/laravel">Laravel Application</a> | ||
</li> | ||
<li> | ||
<a href="https://github.com/laravel/art">Laravel Art</a> | ||
</li> | ||
<li> | ||
<a href="https://github.com/laravel/docs">Laravel Documentation</a> | ||
</li> | ||
<li> | ||
<a href="https://github.com/laravel/cashier">Laravel Cashier</a> | ||
</li> | ||
<li> | ||
<a href="https://github.com/laravel/cashier-braintree">Laravel Cashier for Braintree</a> | ||
</li> | ||
<li> | ||
<a href="https://github.com/laravel/envoy">Laravel Envoy</a> | ||
</li> | ||
<li> | ||
<a href="https://github.com/laravel/framework">Laravel Framework</a> | ||
</li> | ||
<li> | ||
<a href="https://github.com/laravel/homestead">Laravel Homestead</a> | ||
</li> | ||
<li> | ||
<a href="https://github.com/laravel/settler">Laravel Homestead Build Scripts</a> | ||
</li> | ||
<li> | ||
<a href="https://github.com/laravel/horizon">Laravel Horizon</a> | ||
</li> | ||
<li> | ||
<a href="https://github.com/laravel/passport">Laravel Passport</a> | ||
</li> | ||
<li> | ||
<a href="https://github.com/laravel/scout">Laravel Scout</a> | ||
</li> | ||
<li> | ||
<a href="https://github.com/laravel/socialite">Laravel Socialite</a> | ||
</li> | ||
<li> | ||
<a href="https://github.com/laravel/laravel.com">Laravel Website</a> | ||
</li> | ||
</ul> | ||
</div> | ||
|
||
<a name="core-development-discussion"></a> | ||
|
||
## Core Development Discussion | ||
|
||
You may propose new features or improvements of existing Laravel behavior in the Laravel Internals [issue board](https://github.com/laravel/internals/issues). If you propose a new feature, please be willing to implement at least some of the code that would be needed to complete the feature. | ||
|
||
Informal discussion regarding bugs, new features, and implementation of existing features takes place in the `#internals` channel of the [LaraChat](https://larachat.co) Slack team. Taylor Otwell, the maintainer of Laravel, is typically present in the channel on weekdays from 8am-5pm (UTC-06:00 or America/Chicago), and sporadically present in the channel at other times. | ||
|
||
<a name="which-branch"></a> | ||
|
||
## Which Branch? | ||
|
||
**All** bug fixes should be sent to the latest stable branch or to the current LTS branch (5.5). 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 backwards compatible** with the current Laravel release may be sent to the latest stable branch. | ||
|
||
**Major** new features should always be sent to the `master` branch, which contains the upcoming Laravel release. | ||
|
||
If you are unsure if your feature qualifies as a major or minor, please ask Taylor Otwell in the `#internals` channel of the [LaraChat](https://larachat.co) Slack team. | ||
|
||
<a name="security-vulnerabilities"></a> | ||
|
||
## Security Vulnerabilities | ||
|
||
If you discover a security vulnerability within Laravel, please send an email to Taylor Otwell at <[email protected]>. All security vulnerabilities will be promptly addressed. | ||
|
||
<a name="coding-style"></a> | ||
|
||
## Coding Style | ||
|
||
Laravel follows the [PSR-2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md) coding standard and the [PSR-4](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader.md) autoloading standard. | ||
|
||
<a name="phpdoc"></a> | ||
|
||
### 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: | ||
|
||
/** | ||
* Register a binding with the container. | ||
* | ||
* @param string|array $abstract | ||
* @param \Closure|string|null $concrete | ||
* @param bool $shared | ||
* @return void | ||
*/ | ||
public function bind($abstract, $concrete = null, $shared = false) | ||
{ | ||
// | ||
} | ||
|
||
|
||
<a name="styleci"></a> | ||
|
||
### StyleCI | ||
|
||
Don't worry if your code styling isn't perfect! [StyleCI](https://styleci.io/) 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. |