Skip to content

Commit

Permalink
Merge pull request #13 from ynput/Lypsolon-patch-1
Browse files Browse the repository at this point in the history
update template
  • Loading branch information
Lypsolon authored Aug 26, 2024
2 parents 12599a9 + 67eeb41 commit 68aa956
Show file tree
Hide file tree
Showing 4 changed files with 311 additions and 0 deletions.
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
- 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.
105 changes: 105 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
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: |
# impect assumptions
- type: dropdown
attributes:
label: Impact
description: Please specify the impact this PR has on your Operation
multiple: true
options:
- No Impact
- Low
- Mid
- High
- Critical
- Stopper

- type: dropdown
attributes:
label: Assumed Complexity
description: Please specify how complex you assume this will be
multiple: true
options:
- Hours
- Days
- Months
- more than 1/2 Year

- type: dropdown
attributes:
label: Impact Scale
description: Please specify how much other code/tools this might impact
multiple: true
options:
- no other tool
- one more tool
- a few more tools
- an entire tool group
- might propagate to all tools

- type: textarea
attributes:
label: Other tools that get touched
description: in case you put the Impact Scale to anything but None, list all the tools / repos that get affected.

- 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
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
### Description
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.

### Changelog
Paragraphs containing detailed information on the changes made, providing an in-depth description of the updates and enhancements.

### Approval
who needs to approve this, and who is affected by this PR

### Linked issues/branches
list all issues and branches that interact with this branch

### Type of Change
Please delete options that are not relevant.

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality not to work as expected)
- [ ] This change requires a documentation update

## Additional info
Paragraphs of text give context to additional technical information or code examples.

## Testing:

### manual Testing notes:
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.

- [ ] Test A
- [ ] Test B

### presitent Testing notes:
List all tests that have been added to the test to persist. (e.g. unit tests and other automated tests)

- [ ] Test A
- [ ] Test B

### Checklist:
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my code
- [ ] I have commented on my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published in downstream

0 comments on commit 68aa956

Please sign in to comment.