From 0c92e9a5dea92c71b35eac33c6aa5fad42b54a2b Mon Sep 17 00:00:00 2001 From: asheroto Date: Fri, 27 Oct 2023 00:25:32 -0500 Subject: [PATCH 1/8] Improve bug report --- .github/ISSUE_TEMPLATE/bug_report.yml | 120 ++++++++++++++++---------- 1 file changed, 73 insertions(+), 47 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index ec40aa865..fcda77ab3 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,53 +1,79 @@ name: '🕷️ Bug report' description: 'report bugs' -title: '[Bug]' +title: '[Bug]:' labels: - - 'bug' +- '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! - - type: checkboxes - attributes: - label: Non-ChatGPT bug - options: - - label: | - This issue does not occur on chat.openai.com and only occurs on this app. - 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: 'Please specify the version of ChatGPT you are using, a newer version may have fixed the bug you encountered.Check the [UPDATE_LOG](https://github.com/lencx/ChatGPT/blob/main/UPDATE_LOG.md) for more information.' - placeholder: 'e.g. v0.1.0' - validations: +- 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 - - type: textarea - id: bug - attributes: - label: Bug description - description: | - Please describe the bug here,if possible, please provide a minimal example to reproduce the bug.The content of `~/.chatgpt/chatgpt.log` may be helpful if you encounter a crash. - validations: + - label: | + I have given this issue a descriptive title starting with `[Bug]:` such as `[Bug]: Clicking OK closes the program` required: true - - type: input - id: OS - attributes: - label: OS - description: 'Please specify the OS you are using.' - placeholder: 'e.g. Ubuntu 22.04' - 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.' +- 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.Check the [UPDATE_LOG](https://github.com/lencx/ChatGPT/blob/main/UPDATE_LOG.md) for more information.' + 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.' From da7f04dba4ccba0c4265267c8e971262b0443a13 Mon Sep 17 00:00:00 2001 From: asheroto Date: Fri, 27 Oct 2023 00:29:07 -0500 Subject: [PATCH 2/8] Improve bug report --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index fcda77ab3..4672b748b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -19,7 +19,7 @@ body: label: Checklist options: - label: | - This issue does not occur on chat.openai.com and only occurs on this app. + 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` From e20f8b7a90217ac42f75c80f485fc4403ceba4cd Mon Sep 17 00:00:00 2001 From: asheroto Date: Fri, 27 Oct 2023 00:30:54 -0500 Subject: [PATCH 3/8] Improve bug report --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 4672b748b..daf15284e 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,6 +1,6 @@ name: '🕷️ Bug report' description: 'report bugs' -title: '[Bug]:' +title: '[Bug]: ' labels: - 'bug' body: From 88800769b9864d46c9267db4f4e46e57b9e38094 Mon Sep 17 00:00:00 2001 From: asheroto Date: Fri, 27 Oct 2023 00:32:00 -0500 Subject: [PATCH 4/8] Add Release hyperlink --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index daf15284e..de06f23f5 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -33,7 +33,7 @@ body: id: version attributes: label: Version - description: 'Specify the version of ChatGPT you are using, a newer version may have fixed the bug you encountered.Check the [UPDATE_LOG](https://github.com/lencx/ChatGPT/blob/main/UPDATE_LOG.md) for more information.' + 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 From cdb36646abc3322cf13ab18896f33beefa8d051c Mon Sep 17 00:00:00 2001 From: asheroto Date: Fri, 27 Oct 2023 01:50:07 -0500 Subject: [PATCH 5/8] Update all issue templates - Add checkbox to all to confirm title - Improved default title - Improved spelling and grammar --- .github/ISSUE_TEMPLATE/bug_report.yml | 4 +- .github/ISSUE_TEMPLATE/build_error_report.yml | 70 +++++++++---------- 2 files changed, 37 insertions(+), 37 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index de06f23f5..7ed1333b7 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,5 +1,5 @@ name: '🕷️ Bug report' -description: 'report bugs' +description: 'Report bugs' title: '[Bug]: ' labels: - 'bug' @@ -76,4 +76,4 @@ body: id: environment attributes: label: Environment - description: 'If you think your environment may be related to the problem, please describe it here.' + description: 'If you think your environment may be related to the problem, please describe it here.' \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/build_error_report.yml b/.github/ISSUE_TEMPLATE/build_error_report.yml index a2db2fc6b..843c6cb85 100644 --- a/.github/ISSUE_TEMPLATE/build_error_report.yml +++ b/.github/ISSUE_TEMPLATE/build_error_report.yml @@ -1,37 +1,37 @@ -name: '❌ Build error report' -description: 'report errors when building by yourself' -title: '[Build Error]' +name: '❌ Build Error' +description: 'Report errors when building from source code' +title: '[Build Error]: ' labels: - - 'build error' +- '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: 'Please make sure to build from the source code with the latest version of ChatGPT.' - - type: markdown - attributes: - value: | - ## Build error report - Please fill in the following information to help us reproduce the bug: - - type: textarea - id: error - attributes: - label: Error message - description: 'Please paste the error message here.' - validations: - required: true - - type: input - id: OS - attributes: - label: OS - description: 'Please specify the OS you are using.' - placeholder: 'e.g. Ubuntu 22.04' - 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.' +- 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: 'Please make sure to build from the source code with the latest version of ChatGPT.' +- type: markdown + attributes: + value: | + ## Build error report + Please fill in the following information to help us reproduce the bug: +- type: textarea + id: error + attributes: + label: Error message + description: 'Please paste the error message here.' + validations: + required: true +- type: input + id: OS + attributes: + label: OS + description: 'Please specify the OS 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.' From 862de7359b5ffab0220ec50f987dbdb3bccdb1cd Mon Sep 17 00:00:00 2001 From: asheroto Date: Fri, 27 Oct 2023 01:52:01 -0500 Subject: [PATCH 6/8] Overall improvements to issue templates --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- .github/ISSUE_TEMPLATE/build_error_report.yml | 21 ++++-- .github/ISSUE_TEMPLATE/docmentation_issue.yml | 39 ++++++----- .github/ISSUE_TEMPLATE/feature_request.yml | 67 ++++++++++--------- .github/ISSUE_TEMPLATE/security.yml | 67 ++++++++++--------- SECURITY.md | 14 ++++ 6 files changed, 128 insertions(+), 82 deletions(-) create mode 100644 SECURITY.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 7ed1333b7..346c37e6b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -76,4 +76,4 @@ body: id: environment attributes: label: Environment - description: 'If you think your environment may be related to the problem, please describe it here.' \ No newline at end of file + description: 'If you think your environment may be related to the problem, please describe it here.' diff --git a/.github/ISSUE_TEMPLATE/build_error_report.yml b/.github/ISSUE_TEMPLATE/build_error_report.yml index 843c6cb85..98932527c 100644 --- a/.github/ISSUE_TEMPLATE/build_error_report.yml +++ b/.github/ISSUE_TEMPLATE/build_error_report.yml @@ -1,4 +1,4 @@ -name: '❌ Build Error' +name: '❌ Build error' description: 'Report errors when building from source code' title: '[Build Error]: ' labels: @@ -9,24 +9,35 @@ body: value: 'Please make sure to [search for existing issues](https://github.com/lencx/ChatGPT/issues) before filing a new one!' - type: markdown attributes: - value: 'Please make sure to build from the source code with the latest version of ChatGPT.' + 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 - Please fill in the following information to help us reproduce the bug: + Fill in the following information to help us reproduce the bug: - type: textarea id: error attributes: label: Error message - description: 'Please paste the error message here.' + 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: 'Please specify the OS you are using.' + description: 'Specify the OS version you are using.' placeholder: 'e.g. Ubuntu 22.04, Windows 11 Pro' validations: required: true diff --git a/.github/ISSUE_TEMPLATE/docmentation_issue.yml b/.github/ISSUE_TEMPLATE/docmentation_issue.yml index fc64dbd49..c7ac5e7fa 100644 --- a/.github/ISSUE_TEMPLATE/docmentation_issue.yml +++ b/.github/ISSUE_TEMPLATE/docmentation_issue.yml @@ -1,19 +1,26 @@ -name: '📚 Documentation Issue' -description: 'report documentation issues, typos welcome!' -title: '[Doc]' +name: '📚 Documentation issue' +description: 'Report documentation issues, typos welcome!' +title: '[Doc]: ' labels: - - 'documentation' +- '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: textarea - id: doc-description - attributes: - label: 'Provide a description of requested docs changes' - description: 'Briefly describe the requested docs changes.' - validations: +- 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: markdown - attributes: - value: Please limit one request per issue. +- 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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index c1f82ed3b..fa03799b2 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,34 +1,41 @@ name: '⭐ Feature or enhancement request' -description: 'suggest new features or enhancements' -title: '[Feature]' +description: 'Suggest new features or enhancements' +title: '[Feature]: ' labels: - - 'enhancement' +- '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: textarea - id: feature-description - attributes: - label: 'Feature description' - description: "Describe the feature or enhancements you'd like to see." - validations: +- 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: 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. +- 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. diff --git a/.github/ISSUE_TEMPLATE/security.yml b/.github/ISSUE_TEMPLATE/security.yml index 0bb5b5660..a636617d5 100644 --- a/.github/ISSUE_TEMPLATE/security.yml +++ b/.github/ISSUE_TEMPLATE/security.yml @@ -1,34 +1,41 @@ -name: '⚠️ Security&Privacy issue' +name: '⚠️ Security / privacy issue' description: 'Report security or privacy issues' -title: '[Security]' +title: '[Security]: ' labels: - - 'security' +- '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: textarea - id: security-description - attributes: - label: 'Description' - description: 'Describe the security or privacy issue.' - validations: +- 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: 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. +- 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. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 000000000..8e73e38ad --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,14 @@ +# Security Policy + +## Supported Versions + +The following versions are currently supported. + +| Version | Supported | +| ------- | ------------------ | +| 1.1.0 | :white_check_mark: | +| < 1.1.0 | :x: | + +## Reporting a Vulnerability + +If you find a security issue, please create a [security advisory](security/advisories). \ No newline at end of file From a514259947a5640a3f7fca90fde402a259749b35 Mon Sep 17 00:00:00 2001 From: asheroto Date: Fri, 27 Oct 2023 01:55:13 -0500 Subject: [PATCH 7/8] Remove SECURITY.md, will note the PR --- SECURITY.md | 14 -------------- 1 file changed, 14 deletions(-) delete mode 100644 SECURITY.md diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 8e73e38ad..000000000 --- a/SECURITY.md +++ /dev/null @@ -1,14 +0,0 @@ -# Security Policy - -## Supported Versions - -The following versions are currently supported. - -| Version | Supported | -| ------- | ------------------ | -| 1.1.0 | :white_check_mark: | -| < 1.1.0 | :x: | - -## Reporting a Vulnerability - -If you find a security issue, please create a [security advisory](security/advisories). \ No newline at end of file From 6e047d149eb8a4aef0ee8e271127a5ef09b6ec9f Mon Sep 17 00:00:00 2001 From: asheroto Date: Fri, 27 Oct 2023 02:06:01 -0500 Subject: [PATCH 8/8] Update build-error label --- .github/ISSUE_TEMPLATE/build_error_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/build_error_report.yml b/.github/ISSUE_TEMPLATE/build_error_report.yml index 98932527c..5c7a4af12 100644 --- a/.github/ISSUE_TEMPLATE/build_error_report.yml +++ b/.github/ISSUE_TEMPLATE/build_error_report.yml @@ -2,7 +2,7 @@ name: '❌ Build error' description: 'Report errors when building from source code' title: '[Build Error]: ' labels: -- 'build error' +- 'build-error' body: - type: markdown attributes: