hackernews-remix-react icon indicating copy to clipboard operation
hackernews-remix-react copied to clipboard

Published 20 hours ago • verified publisher icon clintonwoo

add github ISSUE_TEMPLATE files

Open cliffordfajardo opened this issue 3 years ago • 2 comments

What is the change?

  1. add bug_report.md to bug-report.yml to enable Github's form based issue template
    • https://youtu.be/qQE1BUkf2-s?t=23
  2. add config.yml file to help direct users to the helpful pages

Motivation

  • encourage's bug reporter's to put more care into their bug report before submission
  • this may help maintainer's receive more detailed & higher quality bug report's
  • adds helpful tips for user's during the process of creating a bug/issue report

Demo of Change

this PR is similar to this one I created here for another repo recently

  • https://github.com/antvis/G6/blob/master/.github/ISSUE_TEMPLATE/bug_report.yml

cliffordfajardo avatar Feb 16 '22 01:02 cliffordfajardo

Nice this looks useful, thanks. I've never noticed this functionality was configurable in GitHub. I'll take a look if I can merge it tomorrow ☺️

clintonwoo avatar Feb 16 '22 03:02 clintonwoo

This looks great and I really want to merge it but seems like it will add a .github folder which is fine but I intended for the project to be easily usable as a reference demo for Remix. Adding the folder might confuse developers using the project!

So I'll just leave this open for now, great to know this functionality is easily available though for open source projects :)

clintonwoo avatar Feb 18 '22 15:02 clintonwoo