Skip to content

Latest commit

 

History

History
31 lines (22 loc) · 1.32 KB

README.md

File metadata and controls

31 lines (22 loc) · 1.32 KB
Raw

new-pr-welcome

a GitHub App built with probot that welcomes new users when they open their first pull request. You can use this welcome message to provide links to resources like the contributing guidelines, code of conduct, etc. It should be located in a .github/config.yml

screen shot 2017-07-07 at 10 40 26 am

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
  1. Add a .github/config.yml file that contains the contents you would like to reply within an newPRWelcomeComment
# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome

# Comment to be posted to on PRs from first time contributors in your repository
newPRWelcomeComment: >
  Thanks for opening this pull request! Please check out our contributing guidelines here: example.md

Setup

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