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

added templates #16

Closed
wants to merge 20 commits into from
Closed
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
152 changes: 152 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report_general.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,152 @@
name: Bug report (general)
description: Report a bug so we can all improve together.
title: "[Bug]_Title"
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
# Description

- type: textarea
attributes:
label: Describe the bug
description: Provide a general overview of the bug and its impact on you or your peers.

- type: input
attributes:
label: Describe yourself
description: Provide a general overview of your perspective on the problem. Are you a developer, user, artist, etc.? This can help us understand you better. Developers, artists, and users sometimes use different ways to describe the same thing, and we want to meet you in your domain.

- type: textarea
attributes:
label: To Reproduce
description: |
Steps to reproduce the behaviour:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

- type: textarea
attributes:
label: How did you discover the bug?
description: |
Tell us what you did when you encountered the bug and what impact it had:
1. I was playing around with x.y / I was working with {softwareA, softwareB, etc.}
2. I opened '...'
3. Then boom

- type: textarea
attributes:
label: Expected behaviour
description: A clear and concise description of what you expected to happen.

- type: textarea
attributes:
label: Screenshots
description: If applicable, please add screenshots to help explain your problem.

- type: markdown
attributes:
value: |
# Environment Description

- type: textarea
attributes:
label: Hardware Setup
description: |
Please describe your system Setup:
- Environment: VM, bare metal
- Hardware Specs: Cpu, Ram, Drives, etc.
- Network: internal/external [e.g., Self, Hosted, Cloud, Peer-to-Peer, Complex VPN, etc.]

- type: textarea
attributes:
label: Software Setup
description: |
Please describe what software you are using so we know what to look out for:
- Affected Software: [e.g., Chrome, Safari, Ayon, Houdini, etc.]
- Driver Versions

- type: input
attributes:
label: User Type
description: |
Please describe what user this setup was made for:
- Environment: Developer, Td, Artist, General User, Admin, etc.

- type: textarea
attributes:
label: Additional Environment Details
description: |
if you have some special stuff running that we should be aware of, here is the place to tell us:

- type: dropdown
validations:
required: true
attributes:
label: What platform are you running on?
description: |
Please specify the operating systems you are using.
multiple: true
options:
- Windows 10
BigRoy marked this conversation as resolved.
Show resolved Hide resolved
- Windows 11
- Windows Server 2019
- Windows Server 2022
- Ubuntu
- CentOS
- Red Hat Enterprise Linux (RHEL)
- Debian
- Fedora
- openSUSE
- Arch Linux
- Linux Mint
- Slackware
- Elementary OS
- Kali Linux
- Gentoo
- Manjaro
- FreeBSD
- OpenBSD
- NetBSD
- Solaris
- OpenIndiana
- AIX (IBM)
- macOS Monterey
- macOS Big Sur
- macOS Catalina
- macOS Mojave
- VMware ESXi (Hypervisor)
- Microsoft Hyper-V (Hypervisor)
- Citrix XenServer (Hypervisor)
- Proxmox (Hypervisor)
- Oracle VM Server
- CoreOS
- Ubuntu Server
- CentOS Stream
- Red Hat Enterprise Linux Server
- SUSE Linux Enterprise Server

- type: textarea
attributes:
label: Additional context
description: Add any other context about the problem here.

- type: checkboxes
attributes:
label: Is there an existing issue with this?
description: >-
Please search to see if an issue with the bug you encountered already exists.
options:
- label: I have searched the existing issues
required: true
- type: checkboxes
attributes:
label: Are there any labels you wish to add?
description: Please search labels and identify those related to your bug.
options:
- label: I have added the relevant labels to the bug report.
required: true
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Ynput Community Discussions
url: https://community.ynput.io
about: Please ask and answer questions here.
- name: Ynput Discord Server
url: https://discord.gg/ynput
about: For community quick chats.
77 changes: 77 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
name: "Feature Request"
description: "Suggest a new feature or enhancement."
title: "[Feature Request]_Title "
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
**Please provide the following information:**

- type: textarea
id: description
attributes:
label: "Description"
description: "Describe the feature or enhancement in detail."
placeholder: "Detailed description of the feature"

- type: textarea
id: rationale
attributes:
label: "Rationale"
description: "Explain why this feature is needed."
placeholder: "Why is this feature important?"

- type: textarea
id: proposed_solution
attributes:
label: "Proposed Solution"
description: "Describe your proposed solution."
placeholder: "Describe your solution."

- type: textarea
id: alternatives
attributes:
label: "Alternatives Considered"
description: "List any alternatives you've considered."
placeholder: "Alternatives considered"

- type: textarea
id: additional_context
attributes:
label: "Additional Context"
description: "Add any other context or screenshots."
placeholder: "Additional context."

- type: markdown
attributes:
value: |
# impact assumptions

- type: dropdown
attributes:
label: Severity
description: Please specify the Severity of this PR on your Operation
multiple: true
options:
- Not Severe
- Low
- Mid
- High
- Critical
- Stopper

- type: checkboxes
attributes:
label: Is there an existing issue with this?
description: Please search to see if an issue with your feature request already exists.
options:
- label: I have searched the existing issues
required: true
- type: checkboxes
attributes:
label: Are there any labels you wish to add?
description: Please search labels and identify those related to your feature request.
options:
- label: I have added the relevant labels to the feature request.
required: true
Loading