File tree Expand file tree Collapse file tree 1 file changed +30
-0
lines changed Expand file tree Collapse file tree 1 file changed +30
-0
lines changed Original file line number Diff line number Diff line change
1
+ Contributing
2
+ ============
3
+
4
+ First of all, ** thank you** for contributing, ** you are awesome** !
5
+
6
+ Here are a few rules to follow in order to ease code reviews, and discussions before
7
+ maintainers accept and merge your work.
8
+
9
+ You MUST follow the [ PSR-1] ( http://www.php-fig.org/psr/psr-1/ ) and
10
+ [ PSR-2] ( http://www.php-fig.org/psr/psr-2/ ) . If you don't know about any of them, you
11
+ should really read the recommendations. Can't wait? Use the [ PHP-CS-Fixer
12
+ tool] ( http://cs.sensiolabs.org/ ) .
13
+
14
+ You MUST run the test suite.
15
+
16
+ You MUST write (or update) unit tests.
17
+
18
+ You SHOULD write documentation.
19
+
20
+ Please, write [ commit messages that make
21
+ sense] ( http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html ) ,
22
+ and [ rebase your branch] ( http://git-scm.com/book/en/Git-Branching-Rebasing )
23
+ before submitting your Pull Request.
24
+
25
+ One may ask you to [ squash your
26
+ commits] ( http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html )
27
+ too. This is used to "clean" your Pull Request before merging it (we don't want
28
+ commits such as ` fix tests ` , ` fix 2 ` , ` fix 3 ` , etc.).
29
+
30
+ Thank you!
You can’t perform that action at this time.
0 commit comments