Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

I have added an Issue section for documentation changes. And updated … #2006

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
122 changes: 80 additions & 42 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,82 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

name: ⚠️ Bug Report
about: Report a reproducible bug in the current release of Ravda
labels: ["bug"]
---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Server (please complete the following information):**
- OS: [e.g. Ubuntu Server X]
- Browser [e.g. chrome, safari]
- Ravada Version [e.g. 0.6]

**Client (please complete the following information):**
- Browser: [e.g. Firefox]
- OS: [e.g. Windows]
- Spice client version [e.g. 1.8]

**Additional context**
Add any other context about the problem here.

Remember that courtesy and proper grammar go a long way.
Please take the time to craft a precise, polite issue.
We will do our best to help, but remember that this is an open source project - none of us are getting paid a salary to develop this project, or act as your personal support hotline ;-)

Carefully search the [existing issues](https://github.com/UPC/ravada/issues), both opened and closed. Your question may have already been asked and answered before!

body:
- type: markdown
attributes:
- type: input
attributes:
label: Ravada version
description: What version of Ravada are you currently running?
placeholder:
validations:
required: true
- type: dropdown
attributes:
label: Client/Server
description: What browser do you have?
options:
- "Server"
- "Client"
validations:
required: true
- type: dropdown
attributes:
label: Operating System
description: What operating system are you using?
options:
- "Ubuntu"
- "Windows"
visibleWhen:
- field: Client/Server value: "Client"
validations:
required: true
- type: dropdown
attributes:
label: Operating System
description: What operating system are you using?
options:
- "Ubuntu Server"
- "Windows Server"
- "Ubuntu"
- "Windows"
visibleWhen:
- field: Client/Server value: "Server"
validations:
required: true
- type: dropdown
attributes:
label: Browser
description: What browser do you have?
options:
- "Firefox"
- "Chrome"
- "Microsoft Edge"
- "Opera"
- "Others"
validations:
required: true
- type: textarea
attributes:
label: Steps to Reproduce
description: >
A clear and concise description of what you expected to happen.
placeholder: |
validations:
required: true
- type: textarea
attributes:
label: Expected Behavior
description: What did you expect to happen?
placeholder:
validations:
required: true
- type: textarea
attributes:
label: Observed Behavior
description: What happened instead?
placeholder: A TypeError exception was raised
validations:
required: true
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_change.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
name: 📖 Documentation Change
about: Suggest an addition or modification to the Ravada documentation
labels: ["documentation"]
---
body:
- type: dropdown
attributes:
label: Change Type
description: What type of change are you proposing?
options:
- Addition
- Correction
- Removal
- Cleanup (formatting, typos, etc.)
validations:
required: true
- type: dropdown
attributes:
label: Area
description: Which section of the documentation is this change to?
options:
- Features
- Administrator
- Guest VM
- Development
- Other
validations:
required: true
- type: textarea
attributes:
label: Proposed Changes
description: Describe the proposed changes and why they are necessary.
validations:
required: true