|
1 | 1 | # The-Welcome-Bot
|
2 | 2 |
|
3 |
| -> A Github App built with [Probot](https://github.com/probot/probot) that welcomes new users in any repository. |
| 3 | +> A Github App built with [Probot](https://github.com/probot/probot) that welcomes new users in any repository. |
| 4 | +
|
| 5 | +## Usage |
| 6 | + |
| 7 | +1. **[Configure the GitHub App](https://github.com/apps/the-welcome-bot)** |
| 8 | + |
| 9 | +A `.github/config.yml` file is required to enable custom messages. The file can override any of these default massages: |
| 10 | + |
| 11 | +```yml |
| 12 | +# Configuration for the-welcome-bot - https://github.com/bash-bot/the-welcome-bot |
| 13 | + |
| 14 | +# Message for a new user who open an issue |
| 15 | +issueOpen: > |
| 16 | + Hello World! Welcome to the project! |
| 17 | + Thanks and congrats for opening your very first issue in this project. |
| 18 | + You may submit a PR on the same if you like! |
| 19 | + Join the Slack channel or the gitter chat for discussions. |
| 20 | + Hope you have a great time here :) |
| 21 | +
|
| 22 | +# Message for a new user who comments on an issue |
| 23 | +issueComment: > |
| 24 | + Hello World! Welcome to the project! |
| 25 | + Thanks and congrats for your very first comment on this project. |
| 26 | + Checkout the ReadMe for more details on it. |
| 27 | + Want to contribute? Make an issue or submit a PR. |
| 28 | + Join the Slack channel or the gitter chat for discussions. |
| 29 | + Hope you have a great time here :) |
| 30 | +
|
| 31 | +# Message for a new user who opens a PR |
| 32 | +prOpen: > |
| 33 | + Hello World! Welcome to the project! |
| 34 | + Thankyou and congarts for your first PR on this project. |
| 35 | + We will review it soon! |
| 36 | + Till then you can checkout the ReadMe for more details on it. |
| 37 | + Join the Slack channel or the gitter chat for discussions. |
| 38 | + Hope you have a great time here :) |
| 39 | +
|
| 40 | +# Default message for a new user |
| 41 | +welcomeMessage: > |
| 42 | + Hello World! Welcome to the project! Feel free to explore it. |
| 43 | + Checkout the ReadMe for more details on it. |
| 44 | + Want to contribute? Make an issue or submit a PR. |
| 45 | + You can check the contributing guides and code of conduct for the same. |
| 46 | + Join the Slack channel or the gitter chat for discussions. |
| 47 | + Hope you have a great time here :) |
| 48 | +``` |
0 commit comments