Skip to content

Commit 106b458

Browse files
necofuryairickstaa
andcommitted
ci: updated issue template (anuraghazra#2127)
* Updated issue templates * style: improve template formatting * style: update formatting Co-authored-by: rickstaa <[email protected]>
1 parent 7f91ef1 commit 106b458

File tree

4 files changed

+84
-84
lines changed

4 files changed

+84
-84
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 43 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: Bug report
2+
description: Create a report to help us improve
3+
labels:
4+
- "bug"
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
> **Warning**
10+
> 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)!!!
11+
- type: textarea
12+
attributes:
13+
label: Describe the bug
14+
description: A clear and concise description of what the bug is.
15+
- type: textarea
16+
attributes:
17+
label: Expected behaviour
18+
description:
19+
A clear and concise description of what you expected to happen.
20+
- type: textarea
21+
attributes:
22+
label: Screenshots / Live demo link
23+
description: If applicable, add screenshots to help explain your problem.
24+
placeholder: Paste the github-readme-stats link as markdown image
25+
- type: textarea
26+
attributes:
27+
label: Additional context
28+
description: Add any other context about the problem here.
29+
- type: markdown
30+
attributes:
31+
value: |
32+
### FAQ
33+
34+
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).
35+
36+
#### Q: My card displays an error
37+
38+
**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.
39+
40+
#### Q: How to hide jupyter Notebook?
41+
42+
**Ans:** `&hide=jupyter%20notebook`.
43+
44+
#### Q: I could not figure out how to deploy on my own vercel instance
45+
46+
**Ans:** Please check:
47+
- Docs: https://github.com/anuraghazra/github-readme-stats/#deploy-on-your-own-vercel-instance
48+
- YT tutorial by codeSTACKr: https://www.youtube.com/watch?v=n6d4KHSKqGk&feature=youtu.be&t=107
49+
50+
#### Q: Language Card is incorrect
51+
52+
**Ans:** Please read these issues/comments before opening any issues regarding language card stats:
53+
- https://github.com/anuraghazra/github-readme-stats/issues/136#issuecomment-665164174
54+
- https://github.com/anuraghazra/github-readme-stats/issues/136#issuecomment-665172181
55+
56+
#### Q: How to count private stats?
57+
58+
**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).

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 41 deletions
This file was deleted.
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Feature request
2+
description: Suggest an idea for this project
3+
labels:
4+
- "enhancement"
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: Is your feature request related to a problem? Please describe.
9+
description: |
10+
A clear and concise description of what the problem is. Ex. I'm always
11+
frustrated when [...]
12+
- type: textarea
13+
attributes:
14+
label: Describe the solution you'd like
15+
description: A clear and concise description of what you want to happen.
16+
- type: textarea
17+
attributes:
18+
label: Describe alternatives you've considered
19+
description: |
20+
A clear and concise description of any alternative solutions or features
21+
you've considered.
22+
- type: textarea
23+
attributes:
24+
label: Additional context
25+
description:
26+
Add any other context or screenshots about the feature request here.

0 commit comments

Comments
 (0)