The goal of this plugin is to check if a pull request doesn't update the README or a file in the docs/ folder, and then prompt the author to include documentation in their pull request. It does so by drawing data from a config.yml file. I also added a whitelist feature, to allow whitelisting through titles that include things such as bug fix, chore, etc. and is also customizable in the config.yml, but is by default empty.
This PR includes the main functionality and some tests. I would love to hear any thoughts/feedback!
✨ update-docs ✨
The goal of this plugin is to check if a pull request doesn't update the README or a file in the
docs/folder, and then prompt the author to include documentation in their pull request. It does so by drawing data from aconfig.ymlfile. I also added a whitelist feature, to allow whitelisting through titles that include things such as bug fix, chore, etc. and is also customizable in theconfig.yml, but is by default empty.This PR includes the main functionality and some tests. I would love to hear any thoughts/feedback!
cc/ @bkeepers @kytrinyx @jbjonesjr @ihavenotea @dmleong @lindseyb