mirror of
https://github.com/Snigdha-OS/snigdhaos-arctic.git
synced 2025-09-20 19:45:01 +02:00
Update report-bug.md
This commit is contained in:

committed by
GitHub

parent
79c8186e56
commit
43de353885
74
.github/ISSUE_TEMPLATE/report-bug.md
vendored
74
.github/ISSUE_TEMPLATE/report-bug.md
vendored
@@ -1,3 +1,75 @@
|
|||||||
|
name: 🐛 Bug Report
|
||||||
|
description: Submit a bug report to help us improve
|
||||||
|
labels: [bug, 'status: needs triage']
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
## Please help us help you!
|
||||||
|
|
||||||
|
Before filing your issue, ask yourself:
|
||||||
|
- Is this clearly a Docusaurus defect?
|
||||||
|
- Do I have basic ideas about where it goes wrong? (For example, if there are stack traces, are they pointing to one file?)
|
||||||
|
- Could it be because of my own mistakes?
|
||||||
|
|
||||||
|
**The GitHub issue tracker is not a support forum**. If you are not sure whether it could be your mistakes, ask in the [Discord server](https://discord.gg/docusaurus) or [GitHub discussions](https://github.com/facebook/docusaurus/discussions) first. The quickest way to verify whether it's a Docusaurus defect is through a **reproduction**, starting with a fresh installation and making changes until the bug is reproduced.
|
||||||
|
|
||||||
|
Make the bug obvious. Ideally, we should be able to understand it without running any code.
|
||||||
|
|
||||||
|
Bugs are fixed faster if you include:
|
||||||
|
- A repro repository to inspect the code
|
||||||
|
- An url to see the problem live (if possible)
|
||||||
|
|
||||||
|
Pro tip: create a reproducible demo of the bug with https://new.docusaurus.io.
|
||||||
|
|
||||||
|
- type: checkboxes
|
||||||
|
attributes:
|
||||||
|
label: Have you read the Contributing Guidelines on issues?
|
||||||
|
options:
|
||||||
|
- label: I have read the [Contributing Guidelines on issues](https://github.com/facebook/docusaurus/blob/main/CONTRIBUTING.md#issues).
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: checkboxes
|
||||||
|
attributes:
|
||||||
|
label: Prerequisites
|
||||||
|
description: Please check the following items before creating a issue. This way we know you've done these steps first.
|
||||||
|
options:
|
||||||
|
- label: I'm using the latest version of Docusaurus.
|
||||||
|
required: true
|
||||||
|
- label: I have tried the `npm run clear` or `yarn clear` command.
|
||||||
|
- label: I have tried `rm -rf node_modules yarn.lock package-lock.json` and re-installing packages.
|
||||||
|
- label: I have tried creating a repro with https://new.docusaurus.io.
|
||||||
|
- label: I have read the console error message carefully (if applicable).
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Description
|
||||||
|
description: A clear and concise description of what the bug is.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
attributes:
|
||||||
|
label: Reproducible demo
|
||||||
|
description: |
|
||||||
|
Paste the link to an example repo, including a `docusaurus.config.js`, and exact instructions to reproduce the issue. It can either be a playground link created from https://new.docusaurus.io, or a git repository.
|
||||||
|
|
||||||
|
> **What happens if you skip this step?** Someone will read your bug report, and maybe will be able to help you, but it’s unlikely that it will get much attention from the team. Eventually, the issue will likely get closed in favor of issues that have reproducible demos.
|
||||||
|
|
||||||
|
Please remember that:
|
||||||
|
|
||||||
|
- Issues without reproducible demos have a very low priority.
|
||||||
|
- The person fixing the bug would have to do that anyway. Please be respectful of their time.
|
||||||
|
- You might figure out the issues yourself as you work on extracting it.
|
||||||
|
|
||||||
|
Thanks for helping us help you!
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Steps to reproduce
|
||||||
|
description: Write down the steps to reproduce the bug. You should start with a fresh installation, or your git repository linked above.
|
||||||
|
placeholder: |
|
||||||
|
1. Step 1...
|
||||||
2. Step 2...
|
2. Step 2...
|
||||||
3. Step 3...
|
3. Step 3...
|
||||||
validations:
|
validations:
|
||||||
@@ -42,4 +114,4 @@
|
|||||||
If you feel like you could contribute to this issue, please check the box below. This would tell us and other people looking for contributions that someone's working on it.
|
If you feel like you could contribute to this issue, please check the box below. This would tell us and other people looking for contributions that someone's working on it.
|
||||||
If you do check this box, please send a pull request within 7 days so we can still delegate this to someone else.
|
If you do check this box, please send a pull request within 7 days so we can still delegate this to someone else.
|
||||||
options:
|
options:
|
||||||
- label: I'd be willing to fix this bug myself
|
- label: I'd be willing to fix this bug myself.
|
||||||
|
Reference in New Issue
Block a user