https://github.com/behaviorbot/new-pr-welcome

Welcome users when they open their first PR in your repository
https://github.com/behaviorbot/new-pr-welcome

github-app probot probot-app

Last synced: 4 months ago
JSON representation

Welcome users when they open their first PR in your repository

• Host: GitHub
• URL: https://github.com/behaviorbot/new-pr-welcome
• Owner: behaviorbot
• License: mit
• Created: 2017-06-22T22:16:03.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-09T17:03:25.000Z (about 2 years ago)
• Last Synced: 2024-09-27T08:02:26.762Z (4 months ago)
• Topics: github-app, probot, probot-app
• Language: JavaScript
• Homepage: https://github.com/apps/welcome
• Size: 1.07 MB
• Stars: 21
• Watchers: 5
• Forks: 19
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# new-pr-welcome

> a GitHub App built with [probot](https://github.com/probot/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`



## Usage

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

- Pull requests: **Read & Write**

  - [x] 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 `newPRWelcomeComment`

```yml

# 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](https://github.com/probot/probot/blob/master/docs/deployment.md) if you would like to run your own instance of this plugin.