Improve issue templates: additional checkboxes, how to reproduce, chatgpt.log, and more #1113
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,53 +1,79 @@ | ||
| name: '🕷️ Bug report' | ||
|
|
||
| description: 'Report bugs' | ||
| title: '[Bug]: ' | ||
| labels: | ||
| - 'bug' | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Please **DO NOT** file issues here if you are having problems with ChatGPT itself. Issues should **ONLY** be created here for bugs that pertain to this package, [lencx/ChatGPT](https://github.com/lencx/ChatGPT). If you are experiencing an issue on [chat.openai.com](https://chat.openai.com), please contact **OpenAI** for support or submit feedback through ChatGPT itself. If you **only have an issue with this app** and do not have the issue on [chat.openai.com](https://chat.openai.com), please file an issue here. | ||
|
|
||
| Please make sure to [search for existing issues](https://github.com/lencx/ChatGPT/issues) before filing a new one! | ||
|
|
||
| **Name your issue appropriately:** give it a sentence that reads well enough for anyone seeing this in the release notes to know what it is. | ||
|
|
||
| When writing out the issue details, please ensure you are writing it as if you were explaining it to somebody else, even if you will be working on and resolving the issue yourself. This helps others to understand the reasons for the issue and for it to be searchable in the future. | ||
| - type: checkboxes | ||
| attributes: | ||
| label: Checklist | ||
| options: | ||
| - label: | | ||
| This issue does **not** occur on `chat.openai.com` and **only** occurs on this app. | ||
| required: true | ||
| - label: | | ||
| I have given this issue a descriptive title starting with `[Bug]:` such as `[Bug]: Clicking OK closes the program` | ||
| required: true | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| ## Bug report | ||
| Please fill in the following information to help us reproduce the bug: | ||
| - type: input | ||
| id: version | ||
| attributes: | ||
| label: Version | ||
| description: 'Specify the version of ChatGPT you are using, a newer version may have fixed the bug you encountered. Download the latest version in [Releases](https://github.com/lencx/ChatGPT/releases) and check the [UPDATE_LOG](https://github.com/lencx/ChatGPT/blob/main/UPDATE_LOG.md) for release note info.' | ||
| placeholder: 'v1.1.0' | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: bug | ||
| attributes: | ||
| label: Bug description | ||
| description: | | ||
| Describe the bug here. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: how-to-reproduce | ||
| attributes: | ||
| label: How to reproduce | ||
| description: | | ||
| What are the steps to reproduce the issue? | ||
| placeholder: | | ||
| 1. Click Preferences | ||
| 2. Then click Control Center | ||
| 3. Then change an option and click OK | ||
| 4. etc | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: chatgpt-log | ||
| attributes: | ||
| label: chatgpt.log | ||
| description: | | ||
| If you encountered a crash, please drag `~/.chatgpt/chatgpt.log` into this textbox and it will upload the file. Please **do not** copy and paste the log as it could be quite long. | ||
| - type: input | ||
| id: OS | ||
| attributes: | ||
| label: OS | ||
| description: 'Specify the OS version you are using.' | ||
| placeholder: 'Ubuntu 22.04, Windows 11 Pro' | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: environment | ||
| attributes: | ||
| label: Environment | ||
| description: 'If you think your environment may be related to the problem, please describe it here.' | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,37 +1,48 @@ | ||
| name: '❌ Build error' | ||
|
|
||
| description: 'Report errors when building from source code' | ||
| title: '[Build Error]: ' | ||
| labels: | ||
| - 'build-error' | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: 'Please make sure to [search for existing issues](https://github.com/lencx/ChatGPT/issues) before filing a new one!' | ||
| - type: markdown | ||
| attributes: | ||
| value: 'Make sure to build from the latest version of the source code.' | ||
| - type: checkboxes | ||
| attributes: | ||
| label: Checklist | ||
| options: | ||
| - label: | | ||
| This issue is related to a problem when **building** from the source code. For regular errors unrelated to **building** please file a regular `Bug report`. | ||
| required: true | ||
| - label: | | ||
| I have given this issue a descriptive title starting with `[Build Error]:` such as `[Build Error]: Error when compiling, cannot find module` | ||
| required: true | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| ## Build error report | ||
| Fill in the following information to help us reproduce the bug: | ||
| - type: textarea | ||
| id: error | ||
| attributes: | ||
| label: Error message | ||
| description: | | ||
| Paste error messages here. If you have a lot of messages and it's getting too lengthy, save them in a text file then drag and drop the file into this textbox. | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| id: OS | ||
| attributes: | ||
| label: OS | ||
| description: 'Specify the OS version you are using.' | ||
| placeholder: 'e.g. Ubuntu 22.04, Windows 11 Pro' | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: environment | ||
| attributes: | ||
| label: Environment | ||
| description: 'If you think your environment may be related to the problem, please describe it here.' | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,19 +1,26 @@ | ||
| name: '📚 Documentation issue' | ||
|
|
||
| description: 'Report documentation issues, typos welcome!' | ||
| title: '[Doc]: ' | ||
| labels: | ||
| - 'documentation' | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: 'Please make sure to [search for existing issues](https://github.com/lencx/ChatGPT/issues) before creating a new one.' | ||
| - type: checkboxes | ||
| attributes: | ||
| label: Checklist | ||
| options: | ||
| - label: | | ||
| I have given this issue a descriptive title starting with `[Doc]:` such as `[Doc]: Misspelling in the README file` | ||
| required: true | ||
| - type: textarea | ||
| id: doc-description | ||
| attributes: | ||
| label: 'Provide a description of requested docs changes' | ||
| description: 'Briefly describe the requested docs changes.' | ||
| validations: | ||
| required: true | ||
| - type: markdown | ||
| attributes: | ||
| value: Please limit one request per issue. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,34 +1,41 @@ | ||
| name: '⭐ Feature or enhancement request' | ||
|
|
||
| description: 'Suggest new features or enhancements' | ||
| title: '[Feature]: ' | ||
| labels: | ||
| - 'enhancement' | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: 'Please make sure to [search for existing issues](https://github.com/lencx/ChatGPT/issues) before creating a new one.' | ||
| - type: checkboxes | ||
| attributes: | ||
| label: Checklist | ||
| options: | ||
| - label: | | ||
| I have given this issue a descriptive title starting with `[Feature]:` such as `[Feature]: Support for Google Translate` | ||
| required: true | ||
| - type: textarea | ||
| id: feature-description | ||
| attributes: | ||
| label: 'Feature description' | ||
| description: "Describe the feature or enhancements you'd like to see." | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: motivation | ||
| attributes: | ||
| label: 'Motivation' | ||
| description: 'Describe the motivation for this feature or enhancement.' | ||
| - type: textarea | ||
| id: alternatives | ||
| attributes: | ||
| label: 'Alternatives' | ||
| description: "Describe any alternatives you've considered." | ||
| - type: textarea | ||
| id: additional-context | ||
| attributes: | ||
| label: 'Additional context' | ||
| description: 'Add any other context or screenshots about the feature request here.' | ||
| - type: markdown | ||
| attributes: | ||
| value: Please limit one request per issue. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,34 +1,41 @@ | ||
| name: '⚠️ Security / privacy issue' | ||
|
|
||
| description: 'Report security or privacy issues' | ||
| title: '[Security]: ' | ||
| labels: | ||
| - 'security' | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: 'Please make sure to [search for existing issues](https://github.com/lencx/ChatGPT/issues) before creating a new one.' | ||
| - type: checkboxes | ||
| attributes: | ||
| label: Checklist | ||
| options: | ||
| - label: | | ||
| I have given this issue a descriptive title starting with `[Security]:` such as `[Security]: Vulnerability found in xyz.js` | ||
| required: true | ||
| - type: textarea | ||
| id: security-description | ||
| attributes: | ||
| label: 'Description' | ||
| description: 'Describe the security or privacy issue.' | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: motivation | ||
| attributes: | ||
| label: 'Motivation' | ||
| description: 'Describe the motivation for this security or privacy issue.' | ||
| - type: textarea | ||
| id: alternatives | ||
| attributes: | ||
| label: 'Alternatives' | ||
| description: "Describe any alternatives you've considered." | ||
| - type: textarea | ||
| id: additional-context | ||
| attributes: | ||
| label: 'Additional context' | ||
| description: 'Add any other context or screenshots about the security or privacy issue here.' | ||
| - type: markdown | ||
| attributes: | ||
| value: Please limit one request per issue. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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