Skip to content

Commit

Permalink
Add issue templates (#2829)
Browse files Browse the repository at this point in the history
* Add issue templates

This adds Bug report and Feature request issue templates.

Signed-off-by: Yashodhan Joshi <[email protected]>

* Change the templates to forms

Signed-off-by: Yashodhan Joshi <[email protected]>

---------

Signed-off-by: Yashodhan Joshi <[email protected]>
  • Loading branch information
YJDoc2 authored Jul 12, 2024
1 parent d6c5996 commit 1f90ff2
Show file tree
Hide file tree
Showing 3 changed files with 92 additions and 0 deletions.
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Bug Report
description: File a bug report.
title: "[Bug]: "
labels: ["kind/bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: description
attributes:
label: Bug Description
description: A clear and concise description of what the bug is
placeholder: Youki crashes when running...
validations:
required: true
- type: textarea
id: reproduction-steps
attributes:
label: Steps to Reproduce
description: How can we reproduce this, or how did you run into this?
placeholder: |
1. Create '...'
2. Run youki as '....'
validations:
required: true
- type: textarea
id: expectations
attributes:
label: Expectation
description: What did you expect to happen instead?
placeholder: Youki should have ran the container...
- type: textarea
id: info
attributes:
label: System and Setup Info
description: Give us more info about the environment and setup
placeholder: |
Add information about your system. If Youki is compiling and running on your system, please add o/p of `youki info` .
If you are experiencing issues in compiling Youki, or related deps, please add details regarding your setup, dependencies etc.
Also if you are running Youki via something else (Docker, podman, k8s) add its info here.
- type: textarea
id: additional
attributes:
label: Additional Context
description: Please add any additional context about the issue
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE_REQ.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Feature Request
description: Suggest an idea for this project
title: "[FEATURE]: "
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: Thank you for creating a feature request!
- type: textarea
id: background
attributes:
label: Background
description: Please add required background information for this request
placeholder: I'm working on a project where...
- type: textarea
id: request
attributes:
label: Feature Request
description: Description of the feature you are requesting
placeholder: I'm proposing that youki should...
validations:
required: true
- type: textarea
id: problem-desc
attributes:
label: Is the request related to some problem running youki?
description: A clear and concise description of what the problem is.
placeholder: I'm always frustrated when [...]
- type: textarea
id: expectations
attributes:
label: Proposed Solution
description: A clear and concise description of what you want to happen.
placeholder: Youki should ....
- type: textarea
id: considerations
attributes:
label: Considerations
description: A clear and concise description of any alternative solutions, features and issues you've considered.
- type: textarea
id: additional
attributes:
label: Additional Context
description: Please add any additional context or screenshots here.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: true # allow people to not use forms, just directly create issues

0 comments on commit 1f90ff2

Please sign in to comment.