From 8467b828600e7f3d94852b054ab40d8493916721 Mon Sep 17 00:00:00 2001 From: "Weizhong Yang a.k.a zonble" Date: Sat, 15 Jan 2022 21:52:06 +0800 Subject: [PATCH 1/3] Update issue templates --- .github/ISSUE_TEMPLATE/----.md | 25 ++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 38 ++++++++++++++++++++++++++++ 2 files changed, 63 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/----.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md diff --git a/.github/ISSUE_TEMPLATE/----.md b/.github/ISSUE_TEMPLATE/----.md new file mode 100644 index 00000000..48a22274 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/----.md @@ -0,0 +1,25 @@ +--- +name: 功能建議 +about: 告訴我們您還有什麼沒被滿足的需求 +title: "[功能建議]" +labels: '' +assignees: '' + +--- + +** 痛點 ** +請告訴我們為什麼目前小麥注音沒辦法解決您的問題。您可以講一個讓大家能感同身受的小故事，像是 + +- 我從 xx 年前開始，使用了 xx 輸入法，我相當依賴其中一項功能，但是小麥沒有... +- 一直以來我在輸入 xx 這類內容的時候，都很花時間，我想要有更有效率的辦法… + +** 功能說明 ** +請大致說明您想要的功能，最後會看起來會像是怎樣。當然最簡單的說明可能會像是「跟 xxx 輸入法一樣」，但請您諒解，不是什麼人都用過你之前用過的那套輸入法，其他人想了解「跟 xxx 輸入法一樣」，首先還得找到那套輸入法，而且有些年代久遠的輸入法還找不到，這樣雙方的認知不同，會大幅降低溝通效率。 + +比方說，您想要某種符號表設計，或許可以提供我們一個草圖，或是其他你喜歡的輸入法的符號表的截圖。遇到某些更複雜的情境，您也可以考慮錄製螢幕畫面供大家參考。 + +** 替代方案 ** +請問，您目前是用什麼方法，可以做到就算沒有這項功能，也可以達最後目的。或著，如果這項功能開發與其他功能衝突，您起碼可以接受什麼方案？ + +** 其他 ** +其他你想跟小麥注音開發者說的話。 diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..dd84ea78 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. From 1140228a4b8d6c6f4f4b6156692d79a779c16390 Mon Sep 17 00:00:00 2001 From: zonble Date: Sat, 15 Jan 2022 22:20:55 +0800 Subject: [PATCH 2/3] Updates issue templates. --- .github/ISSUE_TEMPLATE/bug_report.md | 74 +++++++++++-------- .../{----.md => feature_requst.md} | 15 ++-- 2 files changed, 52 insertions(+), 37 deletions(-) rename .github/ISSUE_TEMPLATE/{----.md => feature_requst.md} (90%) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index dd84ea78..4a11b05f 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,38 +1,54 @@ --- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - +name: 功能問題回報 +about: 請告訴我們您遇到什麼問題 +title: "[功能問題回報]" +labels: "" +assignees: "" --- -**Describe the bug** -A clear and concise description of what the bug is. +在您回報問題之前，建議也可以先參考 Wiki 上的 [常見問題](https://github.com/openvanilla/McBopomofo/wiki/%E5%B8%B8%E8%A6%8B%E5%95%8F%E9%A1%8C) 與 [使用手冊](https://github.com/openvanilla/McBopomofo/wiki/%E4%BD%BF%E7%94%A8%E6%89%8B%E5%86%8A) -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error +**摘要** +請簡單說明您遇到了什麼問題。這份表格雖然是中文的（我們相信注音輸入法的用戶應該都能看懂中文），但開發團隊可以使用中英文溝通，您也可以使用英文回報問題。 -**Expected behavior** -A clear and concise description of what you expected to happen. +**快速分類** +請問您遇到的是： -**Screenshots** -If applicable, add screenshots to help explain your problem. +- [ ] 當機或應用程式閃退 +- [ ] 輸入法叫不出來，或無法正確輸出中文 +- [ ] 無法切換到特定功能 +- [ ] 輸入法效能有問題（執行速度太慢/電腦發燙） +- [ ] UI 顯示不正常 -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] +**問題發生步驟** +請問您是怎麼遇到這個問題的？像是： -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] +1. 打開 xxx app +2. 開始在 xxx 區域打字 +3. 切換到某種設定.. -**Additional context** -Add any other context about the problem here. +**預期正常狀況** +您覺得這是不正常的狀況，那您覺得正常結果應該是…？ + +**螢幕截圖或螢幕錄製** +如果您能夠提供像螢幕截圖或螢幕錄製供大家參考，我們可以從畫面中，看出更多只從文字內容無法了解的線索。 + +**電腦環境** +請問您在怎樣的環境遇到這個問題？ + +- 小麥注音版本：（請填寫版本） +- 鍵盤樣式： + - [x] 標準 + - [ ] 倚天 + - [ ] 許氏 + - [ ] 倚天 26 鍵 + - [ ] 漢語拼音 + - [ ] IBM +- macOS 版本：（請填寫版本） +- 在哪個應用程式中打字遇到問題：（應用程式名稱/版本） +- 電腦機種：（筆電或桌機，使用 Intel 或 Apple Silicon CPU） +- 其他特殊設備：（請填寫是否有外接螢幕、特製鍵盤如非標準美式鍵盤等） +- 特殊設定：（是否原本正常，改了某個系統設定後就遇到問題） + +**其他** +其他你覺得問題發生的疑點，或其他想跟小麥開發者說的話。 diff --git a/.github/ISSUE_TEMPLATE/----.md b/.github/ISSUE_TEMPLATE/feature_requst.md similarity index 90% rename from .github/ISSUE_TEMPLATE/----.md rename to .github/ISSUE_TEMPLATE/feature_requst.md index 48a22274..02eb648a 100644 --- a/.github/ISSUE_TEMPLATE/----.md +++ b/.github/ISSUE_TEMPLATE/feature_requst.md @@ -2,24 +2,23 @@ name: 功能建議 about: 告訴我們您還有什麼沒被滿足的需求 title: "[功能建議]" -labels: '' -assignees: '' - +labels: "" +assignees: "" --- -** 痛點 ** +**痛點** 請告訴我們為什麼目前小麥注音沒辦法解決您的問題。您可以講一個讓大家能感同身受的小故事，像是 - 我從 xx 年前開始，使用了 xx 輸入法，我相當依賴其中一項功能，但是小麥沒有... - 一直以來我在輸入 xx 這類內容的時候，都很花時間，我想要有更有效率的辦法… -** 功能說明 ** +**功能說明** 請大致說明您想要的功能，最後會看起來會像是怎樣。當然最簡單的說明可能會像是「跟 xxx 輸入法一樣」，但請您諒解，不是什麼人都用過你之前用過的那套輸入法，其他人想了解「跟 xxx 輸入法一樣」，首先還得找到那套輸入法，而且有些年代久遠的輸入法還找不到，這樣雙方的認知不同，會大幅降低溝通效率。 比方說，您想要某種符號表設計，或許可以提供我們一個草圖，或是其他你喜歡的輸入法的符號表的截圖。遇到某些更複雜的情境，您也可以考慮錄製螢幕畫面供大家參考。 -** 替代方案 ** +**替代方案** 請問，您目前是用什麼方法，可以做到就算沒有這項功能，也可以達最後目的。或著，如果這項功能開發與其他功能衝突，您起碼可以接受什麼方案？ -** 其他 ** -其他你想跟小麥注音開發者說的話。 +**其他** +其他你想跟小麥注音開發團隊說的話。 From 5a1779b436328b7017b1f9ca9f07f354ce0e41f8 Mon Sep 17 00:00:00 2001 From: zonble Date: Sat, 15 Jan 2022 22:25:33 +0800 Subject: [PATCH 3/3] Updates the issue templates. --- .github/ISSUE_TEMPLATE/bug_report.md | 1 + .github/ISSUE_TEMPLATE/phrase_report.md | 19 +++++++++++++++++++ 2 files changed, 20 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/phrase_report.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 4a11b05f..f2e5611a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -19,6 +19,7 @@ assignees: "" - [ ] 無法切換到特定功能 - [ ] 輸入法效能有問題（執行速度太慢/電腦發燙） - [ ] UI 顯示不正常 +- [ ] 其他 **問題發生步驟** 請問您是怎麼遇到這個問題的？像是： diff --git a/.github/ISSUE_TEMPLATE/phrase_report.md b/.github/ISSUE_TEMPLATE/phrase_report.md new file mode 100644 index 00000000..ac611bf6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/phrase_report.md @@ -0,0 +1,19 @@ +--- +name: 詞庫問題回報 +about: 請告訴我們詞庫的相關問題 +title: "[詞庫問題回報]" +labels: "" +assignees: "" +--- + +**分類** + +- [ ] 錯字或錯誤讀音 +- [ ] 缺字/詞 +- [ ] 其他 + +**說明** +請說明是哪個字寫錯或是標音錯誤，以及正確的寫法與念法。 + +**相關資料** +像是字典的連結等。