behaviorbot / new-issue-welcome

Welcome users when they open their first issue in your repository

new-issue-welcome

a GitHub App built with probot that welcomes new users when they open their first issue. 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

Usage

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

• Issues: Read & Write
  • check the box for Issue events

2. Add a .github/config.yml file that contains the contents you would like to reply within an newIssueWelcomeComment

# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome

# Comment to be posted to on first time issues
newIssueWelcomeComment: >
  Thanks for opening your first issue here! Be sure to follow the issue template!

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.