https://github.com/behaviorbot/welcome

A probot app that welcome new users
https://github.com/behaviorbot/welcome

github-pages probot probot-app

Last synced: 5 days ago
JSON representation

A probot app that welcome new users

• Host: GitHub
• URL: https://github.com/behaviorbot/welcome
• Owner: behaviorbot
• License: mit
• Created: 2017-08-01T17:03:38.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-09-26T21:44:25.000Z (over 1 year ago)
• Last Synced: 2025-01-21T21:02:51.641Z (13 days ago)
• Topics: github-pages, probot, probot-app
• Homepage: https://github.com/apps/welcome
• Size: 154 KB
• Stars: 205
• Watchers: 17
• Forks: 68
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# welcome

> a GitHub App built with [probot](https://github.com/probot/probot) that welcomes new users based off maintainer defined comments that should be located in a `.github/config.yml`

The 3 plugins it combines with are

### New Issue Welcome:

[new-issue-welcome](https://github.com/behaviorbot/new-issue-welcome)



### New PR Welcome:

[new-pr-welcome](https://github.com/behaviorbot/new-pr-welcome)



### First PR Merge:

[first-pr-merge](https://github.com/behaviorbot/first-pr-merge)



## Usage

1. [Install the bot](https://github.com/apps/welcome) on the intended repositories. The plugin requires the following **Permissions and Events**:

- Pull requests: **Read & Write**

- Issues: **Read & Write**

2. Create a `.github/config.yml` file to check for content of the comments:

``` yaml

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

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

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

# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge

# Comment to be posted to on pull requests merged by a first time user

firstPRMergeComment: >

  Congrats on merging your first pull request! We here at behaviorbot are proud of you!

# It is recommended to include as many gifs and emojis as possible!

```

You can opt out of having the bot comment on first time pull requests, pull request merges, or new issues by not filling in a value for each app's respective field.

For some inspiration about what kind of content to include in your `.github/config` files, check out [Electron's Configuration](https://github.com/electron/electron/blob/master/.github/config.yml).