-
Notifications
You must be signed in to change notification settings - Fork 65
[meta] Clean up issue templates in this repository #1141
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
Comments
This is an interesting direction for creating issues rather than using raw templates, it would certainly make creating issues more simpler and also much faster. I will bring this up with the rest of the devfiles team to investigate this further.
I can also suggest is to break up the templates further into subtopics. For example, instead of having one large bug issue template, we could have a bug issue template for the registry and a bug issue template for devfile landing page. I find the most common case I ran into for not using the whole template is when fields are not applicable, breaking down the templates might make this simpler as an alternative to using the issue forms. |
/kind user-story |
To get a sense of what a form-based issue template might look like, the Eclipse Che project might be an example (I'm familiar with it as I contribute there as well): https://github.com/eclipse/che/issues/new?assignees=&labels=kind%2Fbug&projects=&template=bug_report.yml Blocks like
could potentially be replaced with e.g. a dropdown menu |
This issue is stale because it has been open for 90 days with no activity. Remove stale label or comment or this will be closed in 60 days. |
Would like to reopen this issue for review of the outside effort I did to convert our issue templates into issue forms: #1703 |
Unfortunately I had to leave this a Issue forms locked to comma separated value for multi-choice dropdowns and openshift-ci errors no matter how I format it. |
Opened github/issue-parser#17 for a feature request to override the delimiter. |
Opened a discussion post for a feature request to override the delimiter: https://github.com/orgs/community/discussions/157091 |
Description
The issue templates used in this repository are very long and a confusing mix of comments, headings, and bolded text. In addition, they request information that can be confusing or irrelevant to the issue being reported. For example, in the bug template, the "What versions of software are you using?" contains the following to be filled out (highlighting intentionaly disabled as that's what the editor shows currently):
It's not clear how to fill this out, or why it's requesting logs in a section listing versions.
In total, this makes filing issues (and reading issues) in this repository rather difficult. If the level of detail above is actually required, we should use an issue form to prompt for required information in an easy to understand way.
The text was updated successfully, but these errors were encountered: