mirror of
https://github.com/Snigdha-OS/snigdhaos-issues.git
synced 2025-12-06 08:53:50 +01:00
110 lines
4.2 KiB
YAML
110 lines
4.2 KiB
YAML
name: 👾 Report Mistakes in Documentation
|
||
description: Help us to build a better guidelines for you
|
||
labels: [bug]
|
||
body:
|
||
|
||
- type: checkboxes
|
||
attributes:
|
||
label: Have you read the Contributing Guidelines?
|
||
options:
|
||
- label: I have read the [Contributing Guidelines](https://snigdha-os.github.io/documentation/introduction/contributing).
|
||
required: true
|
||
|
||
- type: input
|
||
attributes:
|
||
label: Full URL
|
||
description: Be careful while you copy the link.
|
||
placeholder: e.g https://snigdhaos.org/documentation/installation/download_snigdha_os
|
||
validations:
|
||
required: true
|
||
|
||
- type: dropdown
|
||
attributes:
|
||
label: What Type of Mistake we made?
|
||
description: You can select more than one options.
|
||
multiple: true
|
||
options:
|
||
- Spelling Mistake
|
||
- Wrong Documentation or Code Not Working
|
||
- Incomplete Documentation
|
||
validations:
|
||
required: true
|
||
|
||
- type: textarea
|
||
attributes:
|
||
label: Write the correction
|
||
description: It is not necessary to write here. You can directly edit the [documentation](https://github.com/Snigdha-OS/documentation/tree/master/docs) repository and create pull request.
|
||
placeholder: e.g L10 to L12 "Wite down your correction or edit the code directly."
|
||
validations:
|
||
required: false
|
||
|
||
- type: input
|
||
attributes:
|
||
label: Reproducible demo
|
||
description: |
|
||
> **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!
|
||
placeholder: e.g https://github.com/eshanized/snigdhaos-welcome
|
||
|
||
- 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: |
|
||
Step 1:
|
||
Step 2:
|
||
Step 3:
|
||
Step 4:
|
||
validations:
|
||
required: true
|
||
|
||
- type: textarea
|
||
attributes:
|
||
label: Expected behavior
|
||
description: |
|
||
How did you expect your project to behave? It’s fine if you’re not sure your understanding is correct. Write down what you thought would happen.
|
||
placeholder: Write what you thought would happen.
|
||
validations:
|
||
required: true
|
||
|
||
- type: textarea
|
||
attributes:
|
||
label: Actual behavior
|
||
description: |
|
||
Did something go wrong? Is something broken, or not behaving as you expected?
|
||
Describe this section in detail, and attach screenshots if possible. Don't only say "it doesn't work"!
|
||
Please submit exhaustive and complete log messages (we also need the error stack-traces, not just the message).
|
||
> Please read error messages carefully: it often tells you exactly what you are doing wrong.
|
||
placeholder: Write what happened. Add full console log messages and screenshots, if applicable.
|
||
validations:
|
||
required: true
|
||
|
||
- type: textarea
|
||
attributes:
|
||
label: Your PC Specification
|
||
description: |
|
||
Include as many relevant details about the environment you experienced the bug in.
|
||
> run `cat /etc/os-release` on terminal to see **OS Build ID**
|
||
value: |
|
||
- CPU: [e.g i5 1335U]
|
||
- RAM: [e.g 2 GiB]
|
||
- STORAGE: [e.g SSD/HDD]
|
||
- Snigdha OS Build: [e.g arctic]
|
||
- Snigdha OS Version: [e.g 4.5]
|
||
|
||
- type: checkboxes
|
||
attributes:
|
||
label: Self-service
|
||
description: |
|
||
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.
|
||
options:
|
||
- label: I'd be willing to fix this bug myself.
|