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

asheroto · 2023-10-27T05:38:33Z

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.

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

asheroto · 2023-10-27T07:08:03Z

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.

mrcoder991 · 2024-05-17T09:41:58Z

.github/ISSUE_TEMPLATE/bug_report.yml

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


This is a dummy comment

mrcoder991 · 2024-05-17T09:41:58Z

.github/ISSUE_TEMPLATE/build_error_report.yml

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


This is a dummy comment

mrcoder991 · 2024-05-17T09:41:58Z

.github/ISSUE_TEMPLATE/docmentation_issue.yml

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


This is a dummy comment

mrcoder991 · 2024-05-17T09:41:59Z

.github/ISSUE_TEMPLATE/feature_request.yml

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


This is a dummy comment

mrcoder991 · 2024-05-17T09:41:59Z

.github/ISSUE_TEMPLATE/security.yml

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


This is a dummy comment

mrcoder991 · 2024-05-17T09:44:47Z

.github/ISSUE_TEMPLATE/bug_report.yml

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


This is a dummy comment

mrcoder991 · 2024-05-17T09:44:47Z

.github/ISSUE_TEMPLATE/build_error_report.yml

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


This is a dummy comment

mrcoder991 · 2024-05-17T09:44:47Z

.github/ISSUE_TEMPLATE/docmentation_issue.yml

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


This is a dummy comment

mrcoder991 · 2024-05-17T09:44:48Z

.github/ISSUE_TEMPLATE/feature_request.yml

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


This is a dummy comment

mrcoder991 · 2024-05-17T09:44:48Z

.github/ISSUE_TEMPLATE/security.yml

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


This is a dummy comment

mrcoder991 · 2024-05-17T09:45:14Z

.github/ISSUE_TEMPLATE/bug_report.yml

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


This is a dummy comment

mrcoder991 · 2024-05-17T09:45:15Z

.github/ISSUE_TEMPLATE/build_error_report.yml

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


This is a dummy comment

mrcoder991 · 2024-05-17T09:45:15Z

.github/ISSUE_TEMPLATE/docmentation_issue.yml

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


This is a dummy comment

mrcoder991 · 2024-05-17T09:45:15Z

.github/ISSUE_TEMPLATE/feature_request.yml

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


This is a dummy comment

mrcoder991 · 2024-05-17T09:45:15Z

.github/ISSUE_TEMPLATE/security.yml

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


This is a dummy comment

mrcoder991 · 2024-05-17T09:46:32Z

.github/ISSUE_TEMPLATE/bug_report.yml

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


This is a dummy comment

mrcoder991 · 2024-05-17T09:46:32Z

.github/ISSUE_TEMPLATE/build_error_report.yml

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


This is a dummy comment

mrcoder991 · 2024-05-17T09:46:33Z

.github/ISSUE_TEMPLATE/docmentation_issue.yml

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


This is a dummy comment

mrcoder991 · 2024-05-17T09:46:33Z

.github/ISSUE_TEMPLATE/feature_request.yml

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


This is a dummy comment

mrcoder991 · 2024-05-17T09:46:33Z

.github/ISSUE_TEMPLATE/security.yml

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


This is a dummy comment

mrcoder991 · 2024-05-17T10:06:38Z

.github/ISSUE_TEMPLATE/bug_report.yml

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


This is a dummy comment

mrcoder991 · 2024-05-17T10:06:38Z

.github/ISSUE_TEMPLATE/build_error_report.yml

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


This is a dummy comment

mrcoder991 · 2024-05-17T10:06:38Z

.github/ISSUE_TEMPLATE/docmentation_issue.yml

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


This is a dummy comment

mrcoder991 · 2024-05-17T10:06:38Z

.github/ISSUE_TEMPLATE/feature_request.yml

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


This is a dummy comment

mrcoder991 · 2024-05-17T10:06:38Z

.github/ISSUE_TEMPLATE/security.yml

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


This is a dummy comment

asheroto · 2024-05-18T16:53:11Z

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

asheroto · 2024-05-20T17:25:59Z

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

mrcoder991 · 2024-06-13T12:20:34Z

.github/ISSUE_TEMPLATE/bug_report.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:20:34Z

.github/ISSUE_TEMPLATE/build_error_report.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:20:34Z

.github/ISSUE_TEMPLATE/docmentation_issue.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:20:35Z

.github/ISSUE_TEMPLATE/feature_request.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:20:35Z

.github/ISSUE_TEMPLATE/security.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:21:20Z

.github/ISSUE_TEMPLATE/bug_report.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:21:20Z

.github/ISSUE_TEMPLATE/build_error_report.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:21:20Z

.github/ISSUE_TEMPLATE/docmentation_issue.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:21:20Z

.github/ISSUE_TEMPLATE/feature_request.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:21:20Z

.github/ISSUE_TEMPLATE/security.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:22:44Z

.github/ISSUE_TEMPLATE/bug_report.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:22:44Z

.github/ISSUE_TEMPLATE/build_error_report.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:22:45Z

.github/ISSUE_TEMPLATE/docmentation_issue.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:22:45Z

.github/ISSUE_TEMPLATE/feature_request.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:22:45Z

.github/ISSUE_TEMPLATE/security.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:26:44Z

.github/ISSUE_TEMPLATE/bug_report.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:26:44Z

.github/ISSUE_TEMPLATE/build_error_report.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:26:44Z

.github/ISSUE_TEMPLATE/docmentation_issue.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:26:44Z

.github/ISSUE_TEMPLATE/feature_request.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:26:44Z

.github/ISSUE_TEMPLATE/security.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:27:24Z

.github/ISSUE_TEMPLATE/bug_report.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:27:24Z

.github/ISSUE_TEMPLATE/build_error_report.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:27:24Z

.github/ISSUE_TEMPLATE/docmentation_issue.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:27:24Z

.github/ISSUE_TEMPLATE/feature_request.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:27:25Z

.github/ISSUE_TEMPLATE/security.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:38:28Z

.github/ISSUE_TEMPLATE/bug_report.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:38:28Z

.github/ISSUE_TEMPLATE/build_error_report.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:38:28Z

.github/ISSUE_TEMPLATE/docmentation_issue.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:38:28Z

.github/ISSUE_TEMPLATE/feature_request.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:38:28Z

.github/ISSUE_TEMPLATE/security.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:41:04Z

.github/ISSUE_TEMPLATE/bug_report.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:41:04Z

.github/ISSUE_TEMPLATE/build_error_report.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:41:04Z

.github/ISSUE_TEMPLATE/docmentation_issue.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:41:05Z

.github/ISSUE_TEMPLATE/feature_request.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:41:05Z

.github/ISSUE_TEMPLATE/security.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:48:11Z

.github/ISSUE_TEMPLATE/bug_report.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:48:11Z

.github/ISSUE_TEMPLATE/build_error_report.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:48:11Z

.github/ISSUE_TEMPLATE/docmentation_issue.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:48:11Z

.github/ISSUE_TEMPLATE/feature_request.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:48:11Z

.github/ISSUE_TEMPLATE/security.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:51:26Z

.github/ISSUE_TEMPLATE/bug_report.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:51:26Z

.github/ISSUE_TEMPLATE/build_error_report.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:51:26Z

.github/ISSUE_TEMPLATE/docmentation_issue.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:51:27Z

.github/ISSUE_TEMPLATE/feature_request.yml

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


This is a dummy comment

mrcoder991 · 2024-06-13T12:51:27Z

.github/ISSUE_TEMPLATE/security.yml

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


This is a dummy comment

asheroto added 4 commits October 27, 2023 00:25

Improve bug report

0c92e9a

Improve bug report

da7f04d

Improve bug report

e20f8b7

Add Release hyperlink

8880076

asheroto changed the title ~~Improve bug report~~ Improve bug report: additional checkboxes, How to reproduce, chatgpt.log, and more Oct 27, 2023

asheroto added 4 commits October 27, 2023 01:50

Update all issue templates

cdb3664

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

Overall improvements to issue templates

862de73

Remove SECURITY.md, will note the PR

a514259

Update build-error label

6e047d1

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

mrcoder991 reviewed May 17, 2024

View reviewed changes

mrcoder991 reviewed Jun 13, 2024

View reviewed changes

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

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

Are you sure you want to change the base?

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

Conversation

asheroto commented Oct 27, 2023 • edited Loading

asheroto commented Oct 27, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

asheroto commented May 18, 2024

asheroto commented May 20, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

asheroto commented Oct 27, 2023 •

edited

Loading

asheroto commented Oct 27, 2023 •

edited

Loading

asheroto commented May 20, 2024 •

edited

Loading