Skip to content

Commit a7ad165

Browse files
Updated the contribution guide
1 parent b99cdab commit a7ad165

File tree

1 file changed

+8
-12
lines changed

1 file changed

+8
-12
lines changed

contributions.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55
- [Which Branch?](#which-branch)
66
- [Security Vulnerabilities](#security-vulnerabilities)
77
- [Coding Style](#coding-style)
8-
- [Code Style Fixer](#code-style-fixer)
8+
- [PHPDoc](#phpdoc)
9+
- [StyleCI](#styleci)
910

1011
<a name="bug-reports"></a>
1112
## Bug Reports
@@ -38,7 +39,7 @@ Informal discussion regarding bugs, new features, and implementation of existing
3839
<a name="which-branch"></a>
3940
## Which Branch?
4041

41-
**All** bug fixes should be sent to the latest stable branch. Bug fixes should **never** be sent to the `master` branch unless they fix features that exist only in the upcoming release.
42+
**All** bug fixes should be sent to the latest stable branch, or to the current LTS banch (5.1). Bug fixes should **never** be sent to the `master` branch unless they fix features that exist only in the upcoming release.
4243

4344
**Minor** features that are **fully backwards compatible** with the current Laravel release may be sent to the latest stable branch.
4445

@@ -56,7 +57,8 @@ If you discover a security vulnerability within Laravel, please send an e-mail t
5657

5758
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.
5859

59-
### DocBlocks
60+
<a name="phpdoc"></a>
61+
### PHPDoc
6062

6163
`@param` tags should **not be aligned** and arguments should be separated by **2 spaces**.
6264

@@ -75,13 +77,7 @@ Here's an example block:
7577
//
7678
}
7779

78-
<a name="code-style-fixer"></a>
79-
### Code Style Fixer
80+
<a name="styleci"></a>
81+
### StyleCI
8082

81-
You may use the [PHP-CS-Fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer) to fix your code style before committing.
82-
83-
To get started, [install the tool globally](https://github.com/FriendsOfPHP/PHP-CS-Fixer#globally-manual) and check the code style by issuing the following terminal command from your project's root directory:
84-
85-
```sh
86-
php-cs-fixer fix
87-
```
83+
Don't worry about getting your code style perfect, since [StyleCI](https://styleci.io/) will automatically merge any fixes into our codebase after we merge external contributions. This way, we can focus on the content of the contribution, and not the code style.

0 commit comments

Comments
 (0)