gh-template-bot
gh-template-bot copied to clipboard
🤖 Generate PR Description from Templates for Different Issues and PR
GitHub Template Bot
:robot: Generate Markdown Templates for different Issues, Pull Requests and even Feature Requests
Quick Start
-
Install Template Bot at GitHub Apps Page
-
Now you can type one of these commands in issue/PR then submit
-
/template issue
for general issues -
/template feature
to Propose a Feature in issue -
/template pr
for general pull request -
/template ReplyDup
to fetch your own.github/ReplyDup.md
template -
/template
to ask :robot: for help
- Refresh the page. Template Bot will create Markdown Template for you :tada:
Demo
Forgot command? Don't worry. Bot will help you :100:
![demo3](https://user-images.githubusercontent.com/4994705/33139825-ff63b434-cf73-11e7-87c3-076007336a95.png)
Why
We create issues for different purposes:
Report a Bug, Propose a Feature, Asking for Help ...
But we are used to setup one ISSUE_TEMPLATE.md
for our workflow.
So Template Bot is built to generate templates for different scenarios.
Dev Guide
Run on Local Machine
-
Requirements
- Node >= 10
- Yarn >= 1.3.2
-
Environment
- create file
.env
from.env.example
- edit
.env
and setAPP_ID
according to your GitHub App - download private key to project root according to your GitHub App
- NOTE: to create and config a Github App please follow this Probot doc
- create file
- Install and Run
$ yarn --pure-lockfile
$ yarn run start:nodemon
Test
$ yarn run jest
Deploy to Heroku
$ sh jobs/deploy-heroku.sh
Notes
- Inspired by evenchange4/gh-polls-bot, a Bot creating polls in your issues
- Built with probot, an api-friendly nodejs bot framework
- Built with
create-probot-app
boilerplate for quick start - Deployed on Heroku following this doc by Probot
CONTRIBUTING
CHANGELOG
LICENSE
MIT license https://liuderchi.mit-license.org