summaryrefslogtreecommitdiff
path: root/plugins/af_readability/vendor/andreskrey/readability.php/CONTRIBUTING.md
diff options
context:
space:
mode:
authorAndrew Dolgov <[email protected]>2021-02-26 17:35:58 +0300
committerAndrew Dolgov <[email protected]>2021-02-26 17:35:58 +0300
commitcf1ede0ba8c687d9bfadf1c372546657968f1dd8 (patch)
tree3394cbf3d1cd60d4e1e42f8ef0aa88c4eef368b9 /plugins/af_readability/vendor/andreskrey/readability.php/CONTRIBUTING.md
parent1baf8c521785ab4dc8f474fdd772280737c7e254 (diff)
pull latest readability-php via composer
Diffstat (limited to 'plugins/af_readability/vendor/andreskrey/readability.php/CONTRIBUTING.md')
-rw-r--r--plugins/af_readability/vendor/andreskrey/readability.php/CONTRIBUTING.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/plugins/af_readability/vendor/andreskrey/readability.php/CONTRIBUTING.md b/plugins/af_readability/vendor/andreskrey/readability.php/CONTRIBUTING.md
new file mode 100644
index 000000000..345f71565
--- /dev/null
+++ b/plugins/af_readability/vendor/andreskrey/readability.php/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
+$ make test-all #requires docker and docker-compose
+```
+
+
+**Happy coding**!