Skip to content

Commit ab00962

Browse files
committed
Add CONTRIBUTING guide to explain contribution
1 parent 91c5374 commit ab00962

File tree

2 files changed

+37
-1
lines changed

2 files changed

+37
-1
lines changed

CONTRIBUTING.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Contributing
2+
3+
Contributions are **welcome** and will be fully **credited**.
4+
5+
We accept contributions via Pull Requests on [Github](https://github.com/spatie/laravel-backup).
6+
7+
8+
## Pull Requests
9+
10+
- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer).
11+
12+
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
13+
14+
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
15+
16+
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
17+
18+
- **Create feature branches** - Don't ask us to pull from your master branch.
19+
20+
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
21+
22+
- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
23+
24+
25+
## Running Tests
26+
27+
``` bash
28+
$ vendor/bin/phpunit -v --colors --coverage-text
29+
```
30+
31+
32+
**Happy coding**!

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,9 +196,13 @@ $writer->move('my/new_name.csv'); //writer will write in "new_name.csv"
196196

197197
# Hall of Fame - The list of contributors
198198

199-
* [peter279k](https://github.com/peter279k) - [homepage](https://peterli.website)
199+
* [peter279k](https://github.com/peter279k) - [homepage](https://peterli.website)
200200
* [stevleibelt](https://github.com/stevleibelt) - [homepage](https://stev.leibelt.de)
201201

202+
# Contributing
203+
204+
Please see [CONTRIBUTING](https://github.com/bazzline/php_component_csv/blob/master/CONTRIBUTING.md) for details.
205+
202206
# Final Words
203207

204208
Star it if you like it :-). Add issues if you need it. Pull patches if you enjoy it. Write a blog entry if you use it. [Donate something](https://gratipay.com/~stevleibelt) if you love it :-].

0 commit comments

Comments
 (0)