Skip to content

Commit 2e673f3

Browse files
committed
Docs: Adding github issue/pr templates, license and contributing
1 parent 3245998 commit 2e673f3

File tree

4 files changed

+66
-0
lines changed

4 files changed

+66
-0
lines changed

.github/ISSUE_TEMPLATE.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
| Q | A
2+
| ---------------- | -----
3+
| Bug report? | yes/no
4+
| Feature request? | yes/no
5+
| BC Break report? | yes/no
6+
| RFC? | yes/no
7+
| Version/Branch | x.y.z
8+
9+
<!--
10+
Please fill in this template according to your issue.
11+
-->

.github/PULL_REQUEST_TEMPLATE.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
| Q | A
2+
| ------------- | ---
3+
| Bug fix? | yes/no
4+
| New feature? | yes/no
5+
| BC breaks? | yes/no
6+
| Deprecations? | yes/no
7+
| Tests pass? | yes/no
8+
| Documented? | yes/no
9+
| Fixed tickets | #... <!-- #-prefixed issue number(s), if any -->
10+
| License | MIT
11+
12+
<!--
13+
- Please fill in this template according to the PR you're about to submit.
14+
- Replace this comment by a description of what your PR is solving.
15+
-->

CONTRIBUTING.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Contributing
2+
============
3+
4+
Running tests
5+
--------------
6+
7+
In the bundle directory:
8+
9+
```bash
10+
./vendor/bin/phpunit
11+
```
12+
13+
Giving some love to PHP CS
14+
---------------------------
15+
16+
```bash
17+
composer require --dev 'friendsofphp/php-cs-fixer:^2.0'
18+
bin/php-cs-fixer fix
19+
```

LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) Overblog
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

0 commit comments

Comments
 (0)