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.

Sign up for GitHub

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

Jump to bottom

Add issue templates #2829

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add issue templates #2829

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: Bug report
about: Create a report to help us improve
title: "[BUG]"
labels: kind/bug
assignees: ''

---

**Bug Description**
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.

**System Info**
Add information about your system. If Youki is compiling and running on your system, please add o/p of `youki info` .

**Setup 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.

**Additional context**
Add any other context about the problem here.
Comment on lines +10 to +30
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it really necessary to have all this information to create an issue? I feel that it'd be a waste to miss the opportunity to have an issue created at this stage of the phase. But, it might be useful to have labels and so on.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel that it'd be a waste to miss the opportunity to have an issue created at this stage of the phase

I'm not sure what you mean here 😅

As for the details, I think we can also add an empty issue template, which will not have any fields, and behave similar to how current 'new issue' works. I agree that having to add this much info can be troublesome, but I feel having these details would be good for understanding and debugging the issues.

Copy link
Member

@utam0k utam0k Jun 29, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, let me tell you more details.

but I feel having these details would be good for understanding and debugging the issues.

Yes, this helps us understand the issue. However, how about an issue's author? Perhaps filling in some fields is tedious, and they may stop making issues. I'm worried about it.
But, if we use the issue form, we can mark require or not require in each issue form's section. We use it in order to solve this problem.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey, yep I get it now. That is a valid concern. I'll update the PR to use forms instead.

23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Feature request
about: Suggest an idea for this project
title: "[Feature]"
labels: enhancement
assignees: ''

---

**Background**
Please add required background information for this request

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
Loading