mirror of
https://github.com/Aviortheking/codestats-readme.git
synced 2025-04-22 10:42:08 +00:00
docs: added FAQs in CONTRIBUTING.md & Issue templates
This commit is contained in:
parent
3f46eddeb0
commit
c05357d7b2
29
.github/ISSUE_TEMPLATE/bug_report.md
vendored
29
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@ -1,10 +1,9 @@
|
|||||||
---
|
---
|
||||||
name: Bug report
|
name: Bug report
|
||||||
about: Create a report to help us improve
|
about: Create a report to help us improve
|
||||||
title: ''
|
title: ""
|
||||||
labels: ''
|
labels: ""
|
||||||
assignees: ''
|
assignees: ""
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Describe the bug**
|
**Describe the bug**
|
||||||
@ -18,3 +17,25 @@ If applicable, add screenshots to help explain your problem.
|
|||||||
|
|
||||||
**Additional context**
|
**Additional context**
|
||||||
Add any other context about the problem here.
|
Add any other context about the problem here.
|
||||||
|
|
||||||
|
<!--
|
||||||
|
|
||||||
|
PLEASE READ THE FAQs!!!
|
||||||
|
|
||||||
|
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:
|
||||||
|
- 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 all the 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 not possible. only way is to deploy on your own instance & use your own PAT (Personal Access Token)
|
||||||
|
|
||||||
|
-->
|
||||||
|
29
.github/ISSUE_TEMPLATE/feature_request.md
vendored
29
.github/ISSUE_TEMPLATE/feature_request.md
vendored
@ -1,10 +1,9 @@
|
|||||||
---
|
---
|
||||||
name: Feature request
|
name: Feature request
|
||||||
about: Suggest an idea for this project
|
about: Suggest an idea for this project
|
||||||
title: ''
|
title: ""
|
||||||
labels: ''
|
labels: ""
|
||||||
assignees: ''
|
assignees: ""
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Is your feature request related to a problem? Please describe.**
|
**Is your feature request related to a problem? Please describe.**
|
||||||
@ -18,3 +17,25 @@ A clear and concise description of any alternative solutions or features you've
|
|||||||
|
|
||||||
**Additional context**
|
**Additional context**
|
||||||
Add any other context or screenshots about the feature request here.
|
Add any other context or screenshots about the feature request here.
|
||||||
|
|
||||||
|
<!--
|
||||||
|
|
||||||
|
PLEASE READ THE FAQs!!!
|
||||||
|
|
||||||
|
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:
|
||||||
|
- 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 all the 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 not possible. only way is to deploy on your own instance & use your own PAT (Personal Access Token)
|
||||||
|
|
||||||
|
-->
|
||||||
|
@ -47,6 +47,31 @@ In short, when you submit changes, your submissions are understood to be under t
|
|||||||
|
|
||||||
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/anuraghazra/github-readme-stats/issues/new/choose); it's that easy!
|
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/anuraghazra/github-readme-stats/issues/new/choose); it's that easy!
|
||||||
|
|
||||||
|
## Frequently Asked Questions (FAQs)
|
||||||
|
|
||||||
|
**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:**
|
||||||
|
>
|
||||||
|
> - 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 all the related 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 not possible. only way is to deploy on your own instance & use your own PAT (Personal Access Token)
|
||||||
|
|
||||||
### Bug Reports
|
### Bug Reports
|
||||||
|
|
||||||
**Great Bug Reports** tend to have:
|
**Great Bug Reports** tend to have:
|
||||||
|
Loading…
x
Reference in New Issue
Block a user