liuderchi / gh-template-bot

🤖 Generate PR Description from Templates for Different Issues and PR

GitHub Template Bot

🤖 Generate Markdown Templates for different Issues, Pull Requests and even Feature Requests

Quick Start

1. Install Template Bot at GitHub Apps Page

2. 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 🤖 for help

3. Refresh the page. Template Bot will create Markdown Template for you 🎉

Demo

---

---

Forgot command? Don't worry. Bot will help you 💯

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 set APP_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
• 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

gh-template-bot's Issues

Cannot Use Custom Feature Template

I have created a custom feature template and yet it still keeps pointing back to your template.
The other custom templates I have created like PR and ISSUE are working just great. Thanks for this wonderful tool.

Template Bot no longer working?

Hi

We recently noticed that the Template Bot is no longer working? Is this project still being maintained?

Thanks!

Chrome Extension

When working with non-technical people, a slash command is already a step too far.

I request a browser extension which adds a dropdown box to the new issue form so the creator can select a template and prefill the textarea.

Thank you.

Custom templates

Hey @liuderchi, this is really awesome! I have a feature request:

What if you could have your own custom templates? For example, imagine typing this:

/template bug-report Everything is broken!

And it would read from a file like this, maybe stored in the repo's .github folder:

%DESCRIPTION%

## Bug report
...

And fill in the %DESCRIPTION% with the second part of the command. What do you think?

Add comment templates

I help triage issues on a repository, and it would be really useful if I could just put /reply duplicate 1234 or /reply repro-steps in a comment and have my comment edited into a helpful response for the OP.

🤖 Template Bot Playground 🚀

/template