Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/behaviorbot/first-pr-merge
Congratulate users when their first PR is merged into your repository
https://github.com/behaviorbot/first-pr-merge
github-app probot probot-app
Last synced: 2 months ago
JSON representation
Congratulate users when their first PR is merged into your repository
- Host: GitHub
- URL: https://github.com/behaviorbot/first-pr-merge
- Owner: behaviorbot
- License: mit
- Created: 2017-06-23T22:46:05.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-09T17:03:22.000Z (almost 2 years ago)
- Last Synced: 2024-09-27T08:02:24.759Z (3 months ago)
- Topics: github-app, probot, probot-app
- Language: JavaScript
- Homepage: https://github.com/apps/welcome
- Size: 563 KB
- Stars: 34
- Watchers: 2
- Forks: 20
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# first-pr-merge
> a GitHub App built with [probot](https://github.com/probot/probot) that welcomes new users when their first pull request is merged in. You can use this message to congratulate users or thank them for their contirbutions. 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 a `firstPRMergeComment`
```yml
# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge
# Comment to be posted to on Pr's merged by a first time user
firstPRMergeComment: >
Congrats on merging your first pull request! We here at behaviorbot are proud of you!
```
## 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.