servers
/
ttrss
mirror of https://tt-rss.org/git/tt-rss.git
1
0
Fork 0
Code Issues Releases Wiki Activity
ttrss/plugins/af_readability/vendor/fivefilters/readability.php/CONTRIBUTING.md

1.3 KiB
Raw Blame History

Contributing

Contributions are welcome and will be fully credited.

When it comes to the core article-extraction functionality, please contribute to Mozilla's Readability repository, as we're trying to mirror that here.

For anything else, we accept contributions via Pull Requests on Github.

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 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

$ make test-all #requires docker and docker-compose

Happy coding!