Skip to content

[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

Open
amisevsk opened this issue Jun 20, 2023 · 8 comments · May be fixed by #1703
Open

[meta] Clean up issue templates in this repository #1141

amisevsk opened this issue Jun 20, 2023 · 8 comments · May be fixed by #1703
Assignees
Labels
area/releng Release engineering devtools-week kind/user-story User story for new enhancement

Comments

@amisevsk
Copy link
Contributor

amisevsk commented Jun 20, 2023

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):

## What versions of software are you using?

### Go project

**Operating System and version:**

**Go Pkg Version:**

### Node.js project

<!--
    Please paste the text output of the console in the error output section with a screenshot
-->

**Operating System and version:** 

**Node.js version:**

**Yarn version:**

**Project.json:**

### Web browser

<!--
    Please paste the text output of the console in the error output section with a screenshot
-->

**Operating System and version:**

**Browser name and version:**

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.

@michael-valdron
Copy link
Member

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.

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.

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.

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.

@michael-valdron
Copy link
Member

/kind user-story
/area releng

@openshift-ci openshift-ci bot added kind/user-story User story for new enhancement area/releng Release engineering labels Jun 20, 2023
@amisevsk
Copy link
Contributor Author

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

### Which area this bug is related to?

<!--
    Uncomment appropriate `/area` lines, and delete the rest.
    For example, `> /area api` would simply become: `/area api`
-->

> /area ci
> /area api
> /area library
> /area registry
> /area devworkspace
> /area integration-tests
> /area test-automation
> /area releng
> /area landing-page

could potentially be replaced with e.g. a dropdown menu

@michael-valdron michael-valdron moved this to Need triage in Devfile Project Jun 22, 2023
@mike-hoang mike-hoang moved this from Need triage to Backlog in Devfile Project Jul 4, 2023
@thepetk thepetk moved this from Backlog to To Do 📝 in Devfile Project Aug 4, 2023
@michael-valdron michael-valdron moved this from To Do 📝 to Backlog in Devfile Project Oct 13, 2023
@michael-valdron michael-valdron moved this from Backlog to Refinement in Devfile Project Nov 28, 2023
@Jdubrick Jdubrick moved this from Refinement to Backlog in Devfile Project Jan 18, 2024
Copy link

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.

@github-actions github-actions bot added the lifecycle/stale Stale items. These items have not been updated for 90 days. label Sep 19, 2024
@github-actions github-actions bot added the lifecycle/rotten Rotten items. These items have been stale for 60 days and are now closed. label Nov 18, 2024
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Nov 18, 2024
@github-project-automation github-project-automation bot moved this from Backlog to Done ✅ in Devfile Project Nov 18, 2024
@michael-valdron michael-valdron linked a pull request Apr 13, 2025 that will close this issue
4 tasks
@michael-valdron
Copy link
Member

Would like to reopen this issue for review of the outside effort I did to convert our issue templates into issue forms: #1703

@michael-valdron michael-valdron removed lifecycle/stale Stale items. These items have not been updated for 90 days. lifecycle/rotten Rotten items. These items have been stale for 60 days and are now closed. labels Apr 13, 2025
@michael-valdron michael-valdron moved this from Done ✅ to In Progress 🚧 in Devfile Project Apr 13, 2025
@michael-valdron michael-valdron moved this to Backlog in Devfile Project Apr 13, 2025
@michael-valdron michael-valdron self-assigned this Apr 17, 2025
@michael-valdron michael-valdron moved this from Backlog to In Review 👀 in Devfile Project Apr 17, 2025
@michael-valdron
Copy link
Member

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

### Which area this bug is related to?

<!--
    Uncomment appropriate `/area` lines, and delete the rest.
    For example, `> /area api` would simply become: `/area api`
-->

> /area ci
> /area api
> /area library
> /area registry
> /area devworkspace
> /area integration-tests
> /area test-automation
> /area releng
> /area landing-page

could potentially be replaced with e.g. a dropdown menu

Unfortunately I had to leave this a textarea due to technical limitation with both issue forms and openshift-ci: #1703 (comment)

Issue forms locked to comma separated value for multi-choice dropdowns and openshift-ci errors no matter how I format it.

@michael-valdron
Copy link
Member

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

### Which area this bug is related to?

<!--
    Uncomment appropriate `/area` lines, and delete the rest.
    For example, `> /area api` would simply become: `/area api`
-->

> /area ci
> /area api
> /area library
> /area registry
> /area devworkspace
> /area integration-tests
> /area test-automation
> /area releng
> /area landing-page

could potentially be replaced with e.g. a dropdown menu

Unfortunately I had to leave this a textarea due to technical limitation with both issue forms and openshift-ci: #1703 (comment)

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.

@michael-valdron
Copy link
Member

Opened a discussion post for a feature request to override the delimiter: https://github.com/orgs/community/discussions/157091

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/releng Release engineering devtools-week kind/user-story User story for new enhancement
Projects
Status: In Review 👀
Development

Successfully merging a pull request may close this issue.

3 participants