diff options
Diffstat (limited to 'vendor/fivefilters/readability.php/CONTRIBUTING.md')
| -rw-r--r-- | vendor/fivefilters/readability.php/CONTRIBUTING.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/vendor/fivefilters/readability.php/CONTRIBUTING.md b/vendor/fivefilters/readability.php/CONTRIBUTING.md new file mode 100644 index 0000000..2080832 --- /dev/null +++ b/vendor/fivefilters/readability.php/CONTRIBUTING.md @@ -0,0 +1,31 @@ +# Contributing + +Contributions are **welcome** and will be fully **credited**. + +When it comes to the core article-extraction functionality, please contribute to [Mozilla's Readability](https://github.com/mozilla/readability/) repository, as we're trying to mirror that here. + +For anything else, we accept contributions via Pull Requests on [Github](https://github.com/fivefilters/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 +$ make test-all #requires docker and docker-compose +``` + + +**Happy coding**! |