Skip to content

Latest commit

 

History

History
48 lines (39 loc) · 1.79 KB

README.md

File metadata and controls

48 lines (39 loc) · 1.79 KB

The-Welcome-Bot

A Github App built with Probot that welcomes new users in any repository.

Usage

Configure the GitHub App

A .github/config.yml file is required to enable custom messages. The file can override any of these default massages:

# Configuration for the-welcome-bot - https://github.com/bash-bot/the-welcome-bot

# Message for a new user who open an issue
issueOpen: >
  Hello World! Welcome to the project!
  Thanks and congrats for opening your very first issue in this project.
  You may submit a PR on the same if you like!
  Join the Slack channel or the gitter chat for discussions.
  Hope you have a great time here :)

# Message for a new user who comments on an issue
issueComment: >
  Hello World! Welcome to the project!
  Thanks and congrats for your very first comment on this project.
  Checkout the ReadMe for more details on it.
  Want to contribute? Make an issue or submit a PR.
  Join the Slack channel or the gitter chat for discussions.
  Hope you have a great time here :)

# Message for a new user who opens a PR
prOpen: >
  Hello World! Welcome to the project!
  Thankyou and congarts for your first PR on this project.
  We will review it soon!
  Till then you can checkout the ReadMe for more details on it.
  Join the Slack channel or the gitter chat for discussions.
  Hope you have a great time here :)

# Default message for a new user
welcomeMessage: >
  Hello World! Welcome to the project! Feel free to explore it.
  Checkout the ReadMe for more details on it.
  Want to contribute? Make an issue or submit a PR.
  You can check the contributing guides and code of conduct for the same.
  Join the Slack channel or the gitter chat for discussions.
  Hope you have a great time here :)