Skip to content

Commit 335fbab

Browse files
Create CONTRIBUTING.md
1 parent 9bdb56a commit 335fbab

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Contributing
2+
3+
Contributions are **welcome** and will be fully **credited**. We accept contributions via Pull Requests on [Github](https://github.com/biurad/php-library-starter).
4+
5+
## Pull Requests
6+
7+
- **[PSR-12 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-12-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer).
8+
9+
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
10+
11+
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
12+
13+
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
14+
15+
- **Create feature branches** - Don't ask us to pull from your master branch.
16+
17+
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
18+
19+
- **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.
20+
21+
## Running Tests
22+
23+
``` bash
24+
$ composer test
25+
```
26+
27+
28+
**Happy coding**!

0 commit comments

Comments
 (0)