From 06e3e052df417a3c0a55d56069533861123c2467 Mon Sep 17 00:00:00 2001 From: Brian Choromanski Date: Fri, 7 Oct 2022 13:20:57 -0400 Subject: [PATCH] ci: updated issue template (#2127) * Updated issue templates * style: improve template formatting * style: update formatting Co-authored-by: rickstaa --- .github/ISSUE_TEMPLATE/bug_report.md | 43 ---------------- .github/ISSUE_TEMPLATE/bug_report.yml | 58 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 41 --------------- .github/ISSUE_TEMPLATE/feature_request.yml | 26 ++++++++++ 4 files changed, 84 insertions(+), 84 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 5ed7d3c969ff8..0000000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: "" -labels: "" -assignees: "" ---- - - -**Describe the bug** -A clear and concise description of what the bug is. - -**Expected behaviour** -A clear and concise description of what you expected to happen. - -**Screenshots / Live demo link (paste the github-readme-stats link as markdown image)** -If applicable, add screenshots to help explain your problem. - -**Additional context** -Add any other context about the problem here. - - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000000000..1a5a9532b3230 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,58 @@ +name: Bug report +description: Create a report to help us improve +labels: + - "bug" +body: + - type: markdown + attributes: + value: | + > **Warning** + > PLEASE FIRST READ THE FAQ [(#1770)](https://github.com/anuraghazra/github-readme-stats/discussions/1770) AND COMMON ERROR CODES [(#1772)](https://github.com/anuraghazra/github-readme-stats/issues/1772)!!! + - type: textarea + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. + - type: textarea + attributes: + label: Expected behaviour + description: + A clear and concise description of what you expected to happen. + - type: textarea + attributes: + label: Screenshots / Live demo link + description: If applicable, add screenshots to help explain your problem. + placeholder: Paste the github-readme-stats link as markdown image + - type: textarea + attributes: + label: Additional context + description: Add any other context about the problem here. + - type: markdown + attributes: + value: | + ### FAQ + + Below are some questions that are found in the FAQ. The full FAQ can be found in [#1770](https://github.com/anuraghazra/github-readme-stats/discussions/1770). + + #### Q: My card displays an error + + **Ans:** First, check the common error codes (i.e. https://github.com/anuraghazra/github-readme-stats/issues/1772) and existing issues before creating a new one. + + #### Q: How to hide jupyter Notebook? + + **Ans:** `&hide=jupyter%20notebook`. + + #### Q: I could not figure out how to deploy on my own vercel instance + + **Ans:** Please check: + - Docs: https://github.com/anuraghazra/github-readme-stats/#deploy-on-your-own-vercel-instance + - YT tutorial by codeSTACKr: https://www.youtube.com/watch?v=n6d4KHSKqGk&feature=youtu.be&t=107 + + #### Q: Language Card is incorrect + + **Ans:** Please read these issues/comments before opening any issues regarding language card stats: + - https://github.com/anuraghazra/github-readme-stats/issues/136#issuecomment-665164174 + - https://github.com/anuraghazra/github-readme-stats/issues/136#issuecomment-665172181 + + #### Q: How to count private stats? + + **Ans:** We can only count private commits & we cannot access any other private info of any users, so it's impossible. The only way is to deploy on your own instance & use your own PAT (Personal Access Token). diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 73e080a31240f..0000000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: "" -labels: "" -assignees: "" ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. - - diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000000000..20dc6a8b4c6b4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,26 @@ +name: Feature request +description: Suggest an idea for this project +labels: + - "enhancement" +body: + - type: textarea + attributes: + label: Is your feature request related to a problem? Please describe. + description: | + A clear and concise description of what the problem is. Ex. I'm always + frustrated when [...] + - type: textarea + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen. + - type: textarea + attributes: + label: Describe alternatives you've considered + description: | + A clear and concise description of any alternative solutions or features + you've considered. + - type: textarea + attributes: + label: Additional context + description: + Add any other context or screenshots about the feature request here.