Skip to content

Commit af42194

Browse files
authored
Create CONTRIBUTING.md
1 parent df9b61f commit af42194

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

CONTRIBUTING.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
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/Vinelab/cdn).
6+
7+
## Pull Requests
8+
9+
- **[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).
10+
11+
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
12+
13+
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
14+
15+
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
16+
17+
- **Create feature branches** - Don't ask us to pull from your master branch.
18+
19+
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
20+
21+
- **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.
22+
23+
24+
## Running Tests
25+
26+
``` bash
27+
$ phpunit
28+
```
29+
30+
31+
**Happy coding**!

0 commit comments

Comments
 (0)