Skip to content

Commit 1b4522f

Browse files
committed
1 parent 272f8ae commit 1b4522f

File tree

1 file changed

+63
-0
lines changed

1 file changed

+63
-0
lines changed

CONTRIBUTING.md

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Contribution Guide
2+
3+
Based on [Laravel's](https://github.com/laravel/docs/blob/master/contributions.md)
4+
5+
- [Bug Reports](#bug-reports)
6+
- [Core Development Discussion](#core-development-discussion)
7+
- [Which Branch?](#which-branch)
8+
- [Coding Style](#coding-style)
9+
- [Code Style Fixer](#code-style-fixer)
10+
11+
<a name="bug-reports"></a>
12+
## Bug Reports
13+
14+
To encourage active collaboration, we strongly encourage pull requests, not just bug reports. "Bug reports" may also be sent in the form of a pull request containing a failing test.
15+
16+
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.
17+
18+
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.
19+
20+
<a name="core-development-discussion"></a>
21+
## Core Development Discussion
22+
23+
Discussion regarding bugs, new features, and implementation of existing features takes place in issues on the GitHub repo [here](https://github.com/Superbalist/flysystem-google-storage/issues).
24+
25+
<a name="which-branch"></a>
26+
## Which Branch?
27+
28+
**All** patches should be sent to the `master` branch. Bug fixes should **never** be sent to the `master` branch unless they fix features that exist only in the upcoming release.
29+
30+
<a name="coding-style"></a>
31+
## Coding Style
32+
33+
We follow 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.
34+
35+
### DocBlocks
36+
37+
`@param` tags should **not be aligned** and arguments should be separated by **2 spaces**.
38+
39+
Here's an example block:
40+
41+
/**
42+
* Register a binding with the container.
43+
*
44+
* @param string|array $abstract
45+
* @param \Closure|string|null $concrete
46+
* @param bool $shared
47+
* @return void
48+
*/
49+
public function bind($abstract, $concrete = null, $shared = false)
50+
{
51+
//
52+
}
53+
54+
<a name="code-style-fixer"></a>
55+
### Code Style Fixer
56+
57+
You may use the [PHP-CS-Fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer) to fix your code style before committing.
58+
59+
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:
60+
61+
```sh
62+
php-cs-fixer fix
63+
```

0 commit comments

Comments
 (0)