diff options
author | Andres Rey <[email protected]> | 2017-11-12 20:50:22 +0000 |
---|---|---|
committer | Andres Rey <[email protected]> | 2017-11-12 20:50:22 +0000 |
commit | 84328a0fe7d05de8beeee08b37000305c0f6c14d (patch) | |
tree | 9c2dfbd1cc29c77c90483afddb41621dbb307458 /CONTRIBUTING.md | |
parent | ced49271d11aa7fd26687109bfac7e7d200d80f0 (diff) |
Add missing MD files
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..213b457 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,30 @@ +# Contributing + +Contributions are **welcome** and will be fully **credited**. + +We accept contributions via Pull Requests on [Github](https://github.com/andreskrey/readability.php/). + + +## Pull Requests + +- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date. + +- **Add tests!** - Your patch won't be accepted if it doesn't have tests. + +- **Create feature branches** - Don't ask us to pull from your master branch. + +- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests. + +- **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. + +- **Don't forget to add yourself to AUTHORS.md** - If you want to be credited, make sure you add your information (whatever you want to include) in `AUTHORS.md`. + + +## Running Tests + +``` bash +$ ./vendor/bin/phpunit +``` + + +**Happy coding**! |