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.

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

Improve issue templates: additional checkboxes, how to reproduce, chatgpt.log, and more #1113

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

asheroto
Copy link
Contributor

@asheroto asheroto commented Oct 27, 2023

  • Added required checkbox to remind users to provide a descriptive title for the issue (this is to help prevent users from simply creating an issue without setting a title)
  • Added additional verbiage to remind users to be descriptive about creating a new issue
  • Added How to reproduce as a required step so that users can break down the issue step by step to help developers easily troubleshoot the issue; added placeholders
  • Added optional chatgpt.log textbox and explained to drag the log file into the textbox rather than copying and pasting the text to avoid long pages of issues
  • Improved OS placeholder
  • Improved verbiage of other items in bug report template

You can see a working example of this on my fork of the repo.

@asheroto asheroto changed the title Improve bug report Improve bug report: additional checkboxes, How to reproduce, chatgpt.log, and more Oct 27, 2023
@asheroto
Copy link
Contributor Author

asheroto commented Oct 27, 2023

Recent additions:

  • Add checkbox to all to confirm title
  • Improved default title
  • Improved spelling and grammar

Working example on my fork of the repo.


Recommendations:

Note

The above two items only take 5 minutes but can prevent some issues down the road.

  • Create a build-error label so that the label inside build_error_report.yml will work properly; right now that label is missing from the lencx/ChatGPT repo.

sU3VnbiJPH

NuP3yr9JOj

@asheroto asheroto changed the title Improve bug report: additional checkboxes, How to reproduce, chatgpt.log, and more Improve issue templates: additional checkboxes, how to reproduce, chatgpt.log, and more Oct 27, 2023
@@ -1,53 +1,79 @@
name: '🕷️ Bug report'

Choose a reason for hiding this comment

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

This is a dummy comment

name: '❌ Build error report'
description: 'report errors when building by yourself'
title: '[Build Error]'
name: '❌ Build error'

Choose a reason for hiding this comment

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

This is a dummy comment

name: '📚 Documentation Issue'
description: 'report documentation issues, typos welcome!'
title: '[Doc]'
name: '📚 Documentation issue'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,34 +1,41 @@
name: '⭐ Feature or enhancement request'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,34 +1,41 @@
name: '⚠️ Security&Privacy issue'
name: '⚠️ Security / privacy issue'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,53 +1,79 @@
name: '🕷️ Bug report'

Choose a reason for hiding this comment

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

This is a dummy comment

name: '❌ Build error report'
description: 'report errors when building by yourself'
title: '[Build Error]'
name: '❌ Build error'

Choose a reason for hiding this comment

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

This is a dummy comment

name: '📚 Documentation Issue'
description: 'report documentation issues, typos welcome!'
title: '[Doc]'
name: '📚 Documentation issue'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,34 +1,41 @@
name: '⭐ Feature or enhancement request'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,34 +1,41 @@
name: '⚠️ Security&Privacy issue'
name: '⚠️ Security / privacy issue'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,53 +1,79 @@
name: '🕷️ Bug report'

Choose a reason for hiding this comment

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

This is a dummy comment

name: '❌ Build error report'
description: 'report errors when building by yourself'
title: '[Build Error]'
name: '❌ Build error'

Choose a reason for hiding this comment

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

This is a dummy comment

name: '📚 Documentation Issue'
description: 'report documentation issues, typos welcome!'
title: '[Doc]'
name: '📚 Documentation issue'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,34 +1,41 @@
name: '⭐ Feature or enhancement request'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,34 +1,41 @@
name: '⚠️ Security&Privacy issue'
name: '⚠️ Security / privacy issue'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,53 +1,79 @@
name: '🕷️ Bug report'

Choose a reason for hiding this comment

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

This is a dummy comment

name: '❌ Build error report'
description: 'report errors when building by yourself'
title: '[Build Error]'
name: '❌ Build error'

Choose a reason for hiding this comment

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

This is a dummy comment

name: '📚 Documentation Issue'
description: 'report documentation issues, typos welcome!'
title: '[Doc]'
name: '📚 Documentation issue'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,34 +1,41 @@
name: '⭐ Feature or enhancement request'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,34 +1,41 @@
name: '⚠️ Security&Privacy issue'
name: '⚠️ Security / privacy issue'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,53 +1,79 @@
name: '🕷️ Bug report'

Choose a reason for hiding this comment

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

This is a dummy comment

name: '❌ Build error report'
description: 'report errors when building by yourself'
title: '[Build Error]'
name: '❌ Build error'

Choose a reason for hiding this comment

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

This is a dummy comment

name: '📚 Documentation Issue'
description: 'report documentation issues, typos welcome!'
title: '[Doc]'
name: '📚 Documentation issue'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,34 +1,41 @@
name: '⭐ Feature or enhancement request'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,34 +1,41 @@
name: '⚠️ Security&Privacy issue'
name: '⚠️ Security / privacy issue'

Choose a reason for hiding this comment

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

This is a dummy comment

@asheroto
Copy link
Contributor Author

Did you not want to leave the descriptions in or the prefix on the issue names?

@asheroto
Copy link
Contributor Author

asheroto commented May 20, 2024

image

It looks better to me with a description. This is an example from another repo.

@@ -1,53 +1,79 @@
name: '🕷️ Bug report'

Choose a reason for hiding this comment

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

This is a dummy comment

name: '❌ Build error report'
description: 'report errors when building by yourself'
title: '[Build Error]'
name: '❌ Build error'

Choose a reason for hiding this comment

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

This is a dummy comment

name: '📚 Documentation Issue'
description: 'report documentation issues, typos welcome!'
title: '[Doc]'
name: '📚 Documentation issue'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,34 +1,41 @@
name: '⭐ Feature or enhancement request'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,34 +1,41 @@
name: '⚠️ Security&Privacy issue'
name: '⚠️ Security / privacy issue'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,53 +1,79 @@
name: '🕷️ Bug report'

Choose a reason for hiding this comment

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

This is a dummy comment

name: '❌ Build error report'
description: 'report errors when building by yourself'
title: '[Build Error]'
name: '❌ Build error'

Choose a reason for hiding this comment

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

This is a dummy comment

name: '📚 Documentation Issue'
description: 'report documentation issues, typos welcome!'
title: '[Doc]'
name: '📚 Documentation issue'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,34 +1,41 @@
name: '⭐ Feature or enhancement request'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,34 +1,41 @@
name: '⚠️ Security&Privacy issue'
name: '⚠️ Security / privacy issue'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,53 +1,79 @@
name: '🕷️ Bug report'

Choose a reason for hiding this comment

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

This is a dummy comment

name: '❌ Build error report'
description: 'report errors when building by yourself'
title: '[Build Error]'
name: '❌ Build error'

Choose a reason for hiding this comment

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

This is a dummy comment

name: '📚 Documentation Issue'
description: 'report documentation issues, typos welcome!'
title: '[Doc]'
name: '📚 Documentation issue'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,34 +1,41 @@
name: '⭐ Feature or enhancement request'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,34 +1,41 @@
name: '⚠️ Security&Privacy issue'
name: '⚠️ Security / privacy issue'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,53 +1,79 @@
name: '🕷️ Bug report'

Choose a reason for hiding this comment

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

This is a dummy comment

name: '❌ Build error report'
description: 'report errors when building by yourself'
title: '[Build Error]'
name: '❌ Build error'

Choose a reason for hiding this comment

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

This is a dummy comment

name: '📚 Documentation Issue'
description: 'report documentation issues, typos welcome!'
title: '[Doc]'
name: '📚 Documentation issue'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,34 +1,41 @@
name: '⭐ Feature or enhancement request'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,34 +1,41 @@
name: '⚠️ Security&Privacy issue'
name: '⚠️ Security / privacy issue'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,53 +1,79 @@
name: '🕷️ Bug report'

Choose a reason for hiding this comment

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

This is a dummy comment

name: '❌ Build error report'
description: 'report errors when building by yourself'
title: '[Build Error]'
name: '❌ Build error'

Choose a reason for hiding this comment

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

This is a dummy comment

name: '📚 Documentation Issue'
description: 'report documentation issues, typos welcome!'
title: '[Doc]'
name: '📚 Documentation issue'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,34 +1,41 @@
name: '⭐ Feature or enhancement request'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,34 +1,41 @@
name: '⚠️ Security&Privacy issue'
name: '⚠️ Security / privacy issue'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,53 +1,79 @@
name: '🕷️ Bug report'

Choose a reason for hiding this comment

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

This is a dummy comment

name: '❌ Build error report'
description: 'report errors when building by yourself'
title: '[Build Error]'
name: '❌ Build error'

Choose a reason for hiding this comment

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

This is a dummy comment

name: '📚 Documentation Issue'
description: 'report documentation issues, typos welcome!'
title: '[Doc]'
name: '📚 Documentation issue'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,34 +1,41 @@
name: '⭐ Feature or enhancement request'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,34 +1,41 @@
name: '⚠️ Security&Privacy issue'
name: '⚠️ Security / privacy issue'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,53 +1,79 @@
name: '🕷️ Bug report'

Choose a reason for hiding this comment

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

This is a dummy comment

name: '❌ Build error report'
description: 'report errors when building by yourself'
title: '[Build Error]'
name: '❌ Build error'

Choose a reason for hiding this comment

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

This is a dummy comment

name: '📚 Documentation Issue'
description: 'report documentation issues, typos welcome!'
title: '[Doc]'
name: '📚 Documentation issue'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,34 +1,41 @@
name: '⭐ Feature or enhancement request'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,34 +1,41 @@
name: '⚠️ Security&Privacy issue'
name: '⚠️ Security / privacy issue'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,53 +1,79 @@
name: '🕷️ Bug report'

Choose a reason for hiding this comment

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

This is a dummy comment

name: '❌ Build error report'
description: 'report errors when building by yourself'
title: '[Build Error]'
name: '❌ Build error'

Choose a reason for hiding this comment

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

This is a dummy comment

name: '📚 Documentation Issue'
description: 'report documentation issues, typos welcome!'
title: '[Doc]'
name: '📚 Documentation issue'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,34 +1,41 @@
name: '⭐ Feature or enhancement request'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,34 +1,41 @@
name: '⚠️ Security&Privacy issue'
name: '⚠️ Security / privacy issue'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,53 +1,79 @@
name: '🕷️ Bug report'

Choose a reason for hiding this comment

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

This is a dummy comment

name: '❌ Build error report'
description: 'report errors when building by yourself'
title: '[Build Error]'
name: '❌ Build error'

Choose a reason for hiding this comment

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

This is a dummy comment

name: '📚 Documentation Issue'
description: 'report documentation issues, typos welcome!'
title: '[Doc]'
name: '📚 Documentation issue'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,34 +1,41 @@
name: '⭐ Feature or enhancement request'

Choose a reason for hiding this comment

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

This is a dummy comment

@@ -1,34 +1,41 @@
name: '⚠️ Security&Privacy issue'
name: '⚠️ Security / privacy issue'

Choose a reason for hiding this comment

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

This is a dummy comment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants