Add issue templates #2829
Add issue templates #2829
Conversation
This adds Bug report and Feature request issue templates.
YJDoc2
added
the
kind/cleanup
There was a problem hiding this comment.
May I ask you to use issue forms instead of *.md?
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms
| **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. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Hey, yep I get it now. That is a valid concern. I'll update the PR to use forms instead.
Sure, I had not used them as they are in beta stage, and can potentially change, but after the above comment is discussed, I'll change this for forms. |
This adds Bug report and Feature request issue templates.