https://github.com/mavaddat/community-starter-kit

Welcome automatically generates friendly messages when new team members create their first issue and open or merge their first pull request
https://github.com/mavaddat/community-starter-kit

probot probot-learning

Last synced: 21 days ago
JSON representation

Welcome automatically generates friendly messages when new team members create their first issue and open or merge their first pull request

• Host: GitHub
• URL: https://github.com/mavaddat/community-starter-kit
• Owner: mavaddat
• License: mit
• Created: 2019-06-07T19:21:09.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-06-09T01:36:53.000Z (over 5 years ago)
• Last Synced: 2024-11-01T22:37:29.216Z (2 months ago)
• Topics: probot, probot-learning
• Homepage: https://lab.github.com/githubtraining/community-starter-kit
• Size: 27.3 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Code of conduct: code-of-conduct.md

Awesome Lists containing this project

README

        
# welcome bot: A Probot App

- Welcome automatically generates friendly messages when new team members create their first issue and open or merge their first pull request.

## What it does

- automatically sends users messages encouraging and congratulating them  

- when new team members create their first issue, congratulates them 

- when new team members open or merge their first pull request, encourages them to keep up the good work

## Getting started

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:

```

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

## Need help?

If you need help using this app, we encourage you to:

- Check out the [Getting Started Guide](docs/getting-started.md) in the docs folder of this repository

- If you can't find the answer there, open an issue in this repository and add the label `question`

## Project maintainers

This project is maintained by Monalisa Octocat and friends. Use of this project under the [MIT License](LICENSE.md).