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.
.github/config.yml
file that contains the contents you would like to reply within an updateDocsComment
whiteList
that includes terms, that if found in the title, the bot will not comment on.targetFiles
that includes the files or paths to consider documentation.
# Configuration for update-docs - https://github.com/behaviorbot/update-docs
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:
updateDocsTargetFiles:
# Install dependencies
npm install
# Run the bot
npm start
See the probot deployment docs if you would like to run your own instance of this plugin.