update-docs

a GitHub App built with probot that comments on newly opened Pull Requests that do not update either the README or a file in the /docs folder.

Usage

1. Install the bot on the intended repositories. The plugin requires the following Permissions and Events:

• Pull requests: Read & Write
  • check the box for Pull Request events

2. Add a .github/config.yml file that contains the contents you would like to reply within an updateDocsComment
3. Optionally, you can also add a whiteList that includes terms, that if found in the title, the bot will not comment on.

# Configuration for update-docs - https://github.com/behaviorbot/update-docs

# Comment to be posted to on PRs that don't update documentation
updateDocsComment: >
  Thanks for opening this pull request! The maintainers of this repository would appreciate it if you would update some of our documentation based on your changes.

updateDocsWhiteList:
  - bug
  - chore