From b35b035c09bdbafdaaf95c80a7a53cee33010983 Mon Sep 17 00:00:00 2001 From: yixinBC Date: Tue, 3 Jan 2023 18:39:43 +0800 Subject: [PATCH 1/6] add issue templates --- .github/ISSUE_TEMPLATE/bug_report.yml | 43 +++++++++++++++++++ .github/ISSUE_TEMPLATE/build_error_report.yml | 37 ++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/feature_request.yml | 34 +++++++++++++++ .github/ISSUE_TEMPLATE/security.yml | 34 +++++++++++++++ 5 files changed, 149 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/build_error_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/security.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..0b90a0d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,43 @@ +name: "🕷️ Bug report" +description: "report bugs" +title: "[Bug]" +labels: + - "bug" +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: | + ## 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." + placeholder: "e.g. v0.1.0" + validations: + 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 meet a crash. + 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." diff --git a/.github/ISSUE_TEMPLATE/build_error_report.yml b/.github/ISSUE_TEMPLATE/build_error_report.yml new file mode 100644 index 0000000..7223b20 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/build_error_report.yml @@ -0,0 +1,37 @@ +name: "❌ Build error report" +description: "report errors when building by yourself" +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: "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." \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..3ba13e0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..75eca7e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,34 @@ +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: 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 new file mode 100644 index 0000000..7c0653b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/security.yml @@ -0,0 +1,34 @@ +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: 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. \ No newline at end of file From cef8ffc1a7c0ebb9f16ef91f9a9eec3c5467826f Mon Sep 17 00:00:00 2001 From: kirti purohit Date: Tue, 3 Jan 2023 17:12:25 +0530 Subject: [PATCH 2/6] fix: headers, license --- README.md | 27 ++++++++++++++++++--------- 1 file changed, 18 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 026a5ad..3d15fa5 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,12 @@

ChatGPT

-> ChatGPT Desktop Application +

ChatGPT Desktop Application

+
[![English badge](https://img.shields.io/badge/%E8%8B%B1%E6%96%87-English-blue)](./README.md) [![简体中文 badge](https://img.shields.io/badge/%E7%AE%80%E4%BD%93%E4%B8%AD%E6%96%87-Simplified%20Chinese-blue)](./README-ZH_CN.md) - +[![License](https://img.shields.io/badge/License-Apache%202-green.svg)](https://opencollective.com/lencx-chatgpt) [![ChatGPT downloads](https://img.shields.io/github/downloads/lencx/ChatGPT/total.svg?style=flat-square)](https://github.com/lencx/ChatGPT/releases) [![chat](https://img.shields.io/badge/chat-discord-blue?style=flat&logo=discord)](https://discord.gg/aPhCRf4zZr) [![lencx](https://img.shields.io/twitter/follow/lencx_.svg?style=social)](https://twitter.com/lencx_) @@ -55,20 +56,27 @@ cask "chatgpt", args: { "no-quarantine": true } ## 📢 Announcement +### ChatGPT Prompts! This is a major and exciting update. It works like a `Telegram bot command` and helps you quickly populate custom models to make chatgpt work the way you want it to. This project has taken a lot of my spare time, so if it helps you, please help spread the word or star it would be a great encouragement to me. I hope I can keep updating it and adding more interesting features. ### How does it work? -You can look at [awesome-chatgpt-prompts](https://github.com/f/awesome-chatgpt-prompts) to find interesting features to import into the app. +You can look at [awesome-chatgpt-prompts](https://github.com/f/awesome-chatgpt-prompts) to find interesting features to import into the app. ![chat cmd](./assets/chat-cmd-1.png) + ![chat cmd](./assets/chat-cmd-2.png) +
-In the chatgpt text input area, type a character starting with `/` to bring up the command prompt, press the spacebar, and it will fill the input area with the text associated with the command by default (note: if it contains multiple command prompts, it will only select the first one as the fill, you can keep typing until the first prompted command is the one you want, then press the spacebar. Or use the mouse to click on one of the multiple commands). When the fill is complete, you simply press the Enter key. Under the slash command, use the tab key to modify the contents of the `{q}` tag (only single changes are supported [#54](https://github.com/lencx/ChatGPT/issues/54)). Use the keyboard `⇧` (arrow up) and `⇩` (arrow down) keys to select the slash command. +- In the chatgpt text input area, type a character starting with `/` to bring up the command prompt, press the spacebar, and it will fill the input area with the text associated with the command by default (note: if it contains multiple command prompts, it will only select the first one as the fill, you can keep typing until the first prompted command is the one you want, then press the spacebar. +- Or use the mouse to click on one of the multiple commands). When the fill is complete, you simply press the Enter key. +- Under the slash command, use the tab key to modify the contents of the `{q}` tag (only single changes are supported [#54](https://github.com/lencx/ChatGPT/issues/54)). Use the keyboard `⇧` (arrow up) and `⇩` (arrow down) keys to select the slash command. +
![chatgpt](assets/chatgpt.gif) + ![chatgpt-cmd](assets/chatgpt-cmd.gif) ## ✨ Features @@ -82,7 +90,7 @@ In the chatgpt text input area, type a character starting with `/` to bring up t - Support for slash commands and their configuration (can be configured manually or synchronized from a file [#55](https://github.com/lencx/ChatGPT/issues/55)) - Customize global shortcuts ([#108](https://github.com/lencx/ChatGPT/issues/108)) -### MenuItem +## MenuItem - **Preferences** - `Theme` - `Light`, `Dark` (Only macOS and Windows are supported). @@ -172,19 +180,19 @@ Currently, only json and csv are supported for synchronizing custom files, and t ## ❓FAQ -### Can't open ChatGPT +### 1. Can't open ChatGPT If you cannot open the application after the upgrade, please try to clear the configuration file, which is in the `~/.chatgpt/*` directory. -### Out of sync login status between multiple windows +### 2. Out of sync login status between multiple windows If you have already logged in in the main window, but the system tray window shows that you are not logged in, you can fix it by restarting the application (`Menu -> Preferences -> Restart ChatGPT`). -### Is it safe? +### 3. Is it safe? It's safe, just a wrapper for [OpenAI ChatGPT](https://chat.openai.com) website, no other data transfer exists (you can check the source code). -### Developer cannot be verified? +### 4. Developer cannot be verified? - [Open a Mac app from an unidentified developer](https://support.apple.com/en-sg/guide/mac-help/mh40616/mac) @@ -216,6 +224,7 @@ yarn dev # bundle path: src-tauri/target/release/bundle yarn build ``` +--- ## ❤️ Thanks From 139afa29430d7398611c40246a0e9203d9910301 Mon Sep 17 00:00:00 2001 From: kirti purohit Date: Tue, 3 Jan 2023 22:20:06 +0530 Subject: [PATCH 3/6] removed numbering & rectified html --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 3d15fa5..3176e05 100644 --- a/README.md +++ b/README.md @@ -61,7 +61,7 @@ This is a major and exciting update. It works like a `Telegram bot command` and ### How does it work? -You can look at [awesome-chatgpt-prompts](https://github.com/f/awesome-chatgpt-prompts) to find interesting features to import into the app. +You can look at **[awesome-chatgpt-prompts](https://github.com/f/awesome-chatgpt-prompts)** to find interesting features to import into the app. ![chat cmd](./assets/chat-cmd-1.png) @@ -180,19 +180,19 @@ Currently, only json and csv are supported for synchronizing custom files, and t ## ❓FAQ -### 1. Can't open ChatGPT +### Can't open ChatGPT If you cannot open the application after the upgrade, please try to clear the configuration file, which is in the `~/.chatgpt/*` directory. -### 2. Out of sync login status between multiple windows +### Out of sync login status between multiple windows If you have already logged in in the main window, but the system tray window shows that you are not logged in, you can fix it by restarting the application (`Menu -> Preferences -> Restart ChatGPT`). -### 3. Is it safe? +### Is it safe? It's safe, just a wrapper for [OpenAI ChatGPT](https://chat.openai.com) website, no other data transfer exists (you can check the source code). -### 4. Developer cannot be verified? +### Developer cannot be verified? - [Open a Mac app from an unidentified developer](https://support.apple.com/en-sg/guide/mac-help/mh40616/mac) From 060f3b59155bee28b2a1b0765cf339b2577809ab Mon Sep 17 00:00:00 2001 From: yixinBC Date: Wed, 4 Jan 2023 09:22:10 +0800 Subject: [PATCH 4/6] fix:typo --- .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 0b90a0d..0bb0fd0 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -25,7 +25,7 @@ body: 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 meet a crash. + 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: required: true - type: input From a6912deb9f7ca76fa362bcf85259e16628c427b9 Mon Sep 17 00:00:00 2001 From: yixinBC Date: Wed, 4 Jan 2023 09:34:40 +0800 Subject: [PATCH 5/6] add issue templates for docs --- .github/ISSUE_TEMPLATE/docmentation_issue.yml | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/docmentation_issue.yml diff --git a/.github/ISSUE_TEMPLATE/docmentation_issue.yml b/.github/ISSUE_TEMPLATE/docmentation_issue.yml new file mode 100644 index 0000000..6aff586 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docmentation_issue.yml @@ -0,0 +1,19 @@ +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: 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. \ No newline at end of file From 0197d121193ddb718ee7b062b3b094a6a60d2574 Mon Sep 17 00:00:00 2001 From: lencx Date: Wed, 4 Jan 2023 11:29:41 +0800 Subject: [PATCH 6/6] readme --- README-ZH_CN.md | 4 ++-- README.md | 10 +++++----- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README-ZH_CN.md b/README-ZH_CN.md index f325704..74c93fd 100644 --- a/README-ZH_CN.md +++ b/README-ZH_CN.md @@ -6,8 +6,8 @@ > ChatGPT 桌面应用 [![English badge](https://img.shields.io/badge/%E8%8B%B1%E6%96%87-English-blue)](./README.md) -[![简体中文 badge](https://img.shields.io/badge/%E7%AE%80%E4%BD%93%E4%B8%AD%E6%96%87-Simplified%20Chinese-blue)](./README-ZH_CN.md) - +[![简体中文 badge](https://img.shields.io/badge/%E7%AE%80%E4%BD%93%E4%B8%AD%E6%96%87-Simplified%20Chinese-blue)](./README-ZH_CN.md)\ +![License](https://img.shields.io/badge/License-Apache%202-green.svg) [![ChatGPT downloads](https://img.shields.io/github/downloads/lencx/ChatGPT/total.svg?style=flat-square)](https://github.com/lencx/ChatGPT/releases) [![chat](https://img.shields.io/badge/chat-discord-blue?style=flat&logo=discord)](https://discord.gg/aPhCRf4zZr) [![lencx](https://img.shields.io/twitter/follow/lencx_.svg?style=social)](https://twitter.com/lencx_) diff --git a/README.md b/README.md index 3176e05..fbf4bfa 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,8 @@
[![English badge](https://img.shields.io/badge/%E8%8B%B1%E6%96%87-English-blue)](./README.md) -[![简体中文 badge](https://img.shields.io/badge/%E7%AE%80%E4%BD%93%E4%B8%AD%E6%96%87-Simplified%20Chinese-blue)](./README-ZH_CN.md) -[![License](https://img.shields.io/badge/License-Apache%202-green.svg)](https://opencollective.com/lencx-chatgpt) +[![简体中文 badge](https://img.shields.io/badge/%E7%AE%80%E4%BD%93%E4%B8%AD%E6%96%87-Simplified%20Chinese-blue)](./README-ZH_CN.md)\ +![License](https://img.shields.io/badge/License-Apache%202-green.svg) [![ChatGPT downloads](https://img.shields.io/github/downloads/lencx/ChatGPT/total.svg?style=flat-square)](https://github.com/lencx/ChatGPT/releases) [![chat](https://img.shields.io/badge/chat-discord-blue?style=flat&logo=discord)](https://discord.gg/aPhCRf4zZr) [![lencx](https://img.shields.io/twitter/follow/lencx_.svg?style=social)](https://twitter.com/lencx_) @@ -27,7 +27,7 @@ - `Windows`: [ChatGPT_0.7.4_x64_en-US.msi](https://github.com/lencx/ChatGPT/releases/download/v0.7.4/ChatGPT_0.7.4_x64_en-US.msi) - `Linux`: - [chat-gpt_0.7.4_amd64.deb](https://github.com/lencx/ChatGPT/releases/download/v0.7.4/chat-gpt_0.7.4_amd64.deb) - - [chat-gpt_0.7.4_amd64.AppImage](https://github.com/lencx/ChatGPT/releases/download/v0.7.4/chat-gpt_0.7.4_amd64.AppImage): **works reliably, you can try it if `.deb` fails to run.** + - [chat-gpt_0.7.4_amd64.AppImage](https://github.com/lencx/ChatGPT/releases/download/v0.7.4/chat-gpt_0.7.4_amd64.AppImage): **works reliably, you can try it if `.deb` fails to run** [Other version...](https://github.com/lencx/ChatGPT/releases) @@ -70,8 +70,8 @@ You can look at **[awesome-chatgpt-prompts](https://github.com/f/awesome-chatgpt
-- In the chatgpt text input area, type a character starting with `/` to bring up the command prompt, press the spacebar, and it will fill the input area with the text associated with the command by default (note: if it contains multiple command prompts, it will only select the first one as the fill, you can keep typing until the first prompted command is the one you want, then press the spacebar. -- Or use the mouse to click on one of the multiple commands). When the fill is complete, you simply press the Enter key. +- In the chatgpt text input area, type a character starting with `/` to bring up the command prompt, press the spacebar, and it will fill the input area with the text associated with the command by default (note: if it contains multiple command prompts, it will only select the first one as the fill, you can keep typing until the first prompted command is the one you want, then press the spacebar. +- Or use the mouse to click on one of the multiple commands). When the fill is complete, you simply press the Enter key. - Under the slash command, use the tab key to modify the contents of the `{q}` tag (only single changes are supported [#54](https://github.com/lencx/ChatGPT/issues/54)). Use the keyboard `⇧` (arrow up) and `⇩` (arrow down) keys to select the slash command.