From b403396003cf78dd4ac14b621c7ac940b61c027e Mon Sep 17 00:00:00 2001 From: ShikiSuen Date: Thu, 25 Aug 2022 23:00:25 +0800 Subject: [PATCH] Repo // Add issue templates. --- .gitee/ISSUE_TEMPLATE.zh-TW.md | 44 +++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 55 ++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_requst.md | 30 +++++++++++++ .github/ISSUE_TEMPLATE/phrase_report.md | 24 +++++++++++ 4 files changed, 153 insertions(+) create mode 100644 .gitee/ISSUE_TEMPLATE.zh-TW.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_requst.md create mode 100644 .github/ISSUE_TEMPLATE/phrase_report.md diff --git a/.gitee/ISSUE_TEMPLATE.zh-TW.md b/.gitee/ISSUE_TEMPLATE.zh-TW.md new file mode 100644 index 00000000..c8c683a3 --- /dev/null +++ b/.gitee/ISSUE_TEMPLATE.zh-TW.md @@ -0,0 +1,44 @@ +### **請在開新的工單之前閱讀《[故障提報與用儀器捉蟲](https://vchewing.github.io/BUGREPORT.html)》按照裡面的方法先電郵聯絡、或至少在開工單之後電郵知會之。因各種可能原因，威注音的主程式師可能無法隨時收取 GitHub 與 Gitee 的工單提醒訊息。** + +### 請勿利用工單遞交**詞語新增請求**。所有「詞語新增請求」請一律使用電郵提報。 + +**摘要** +請簡單說明您遇到了什麼問題。這份表格雖然是中文的（我們相信注音輸入法的用戶應該都能看懂中文），但開發團隊可以使用中英文溝通，您也可以使用英文提報問題。 + +**快速分類** +請問您遇到的是： + +- [ ] 輸入法崩潰或正在接受文字輸入的應用程式崩潰 +- [ ] 輸入法叫不出來，或無法正確敲出中文 +- [ ] 無法切換至特定功能的啟用/停用狀態 +- [ ] 輸入法效能有問題（執行速度太慢/電腦發燙） +- [ ] 輸入法應用程式介面顯示不正常（IMK 選字窗的應用介面美術瑕疵恕不受理，因為是 Apple 負責的） +- [ ] 輸入法亂放屁（請確保偏好設定內的廉恥模式的勾沒有被去掉） +- [ ] 其他 + +**問題發生步驟** +請問您是怎麼遇到這個問題的？像是： + +1. 先執行某個接收文字的客體應用 +2. 開始在某個區域打字 +3. 切換到某種設定/模式… + +**預期正常狀況** +您覺得這是不正常的狀況，那您覺得正常結果應該是…？ + +**螢幕截圖或螢幕錄製** +如果您能夠提供像螢幕截圖或螢幕錄製供大家參考，我們可以從畫面中，看出更多只從文字內容無法了解的線索。 + +**電腦環境** +請問您在怎樣的環境遇到這個問題？ + +- 威注音版本：（請填寫版本） +- 注音排列與基礎鍵盤佈局：（在偏好設定視窗的「鍵盤設定」內可以查詢到） +- macOS 版本：（請填寫版本與建置編號，例：「13.0 (22A5321d)」） +- 在哪個應用程式中打字遇到問題：（應用程式名稱/版本） +- 電腦機種：（筆電或桌機，使用 Intel 或 Apple Silicon CPU） +- 其他特殊設備：（請填寫是否有外接螢幕、特製鍵盤如非標準美式鍵盤等） +- 特殊設定：（是否原本正常，改了某個系統設定後就遇到問題） + +**其他** +其他你覺得問題發生的疑點，或其他你想跟威注音開發團隊說的話。 diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..d29629e9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,55 @@ +--- +name: 功能問題提報 +about: 請告訴我們您遇到什麼問題 +title: "[功能問題提報]" +labels: "BUG / DEBUFF / REGRESSION" +assignees: "" +--- + +### **請在開新的工單之前閱讀《[故障提報與用儀器捉蟲](https://vchewing.github.io/BUGREPORT.html)》按照裡面的方法先電郵聯絡、或至少在開工單之後電郵知會之。因各種可能原因，威注音的主程式師可能無法隨時收取 GitHub 與 Gitee 的工單提醒訊息。** + +**摘要** +請簡單說明您遇到了什麼問題。這份表格雖然是中文的（我們相信注音輸入法的用戶應該都能看懂中文），但開發團隊可以使用中英文溝通，您也可以使用英文提報問題。 + +**快速分類** +請問您遇到的是： + +- [ ] 輸入法崩潰或正在接受文字輸入的應用程式崩潰 +- [ ] 輸入法叫不出來，或無法正確敲出中文 +- [ ] 無法切換至特定功能的啟用/停用狀態 +- [ ] 輸入法效能有問題（執行速度太慢/電腦發燙） +- [ ] 輸入法應用程式介面顯示不正常（IMK 選字窗的應用介面美術瑕疵恕不受理，因為是 Apple 負責的） +- [ ] 輸入法亂放屁（請確保偏好設定內的廉恥模式的勾沒有被去掉） +- [ ] 其他 + +**問題發生步驟** +請問您是怎麼遇到這個問題的？像是： + +1. 先執行某個接收文字的客體應用 +2. 開始在某個區域打字 +3. 切換到某種設定/模式… + +**預期正常狀況** +您覺得這是不正常的狀況，那您覺得正常結果應該是…？ + +**螢幕截圖或螢幕錄製** +如果您能夠提供像螢幕截圖或螢幕錄製供大家參考，我們可以從畫面中，看出更多只從文字內容無法了解的線索。 + +**小麥注音是否也有該問題** +威注音一開始是小麥注音的下游。雖經大量修改與重構，但也難免會受到之前繼承過來的可能存在的上游 Bug 或設計缺陷的影響。 + +所以呢，這個問題也請答覆。但如果是威注音特有功能出現故障的話，那這個問題可以不用答覆。 + +**電腦環境** +請問您在怎樣的環境遇到這個問題？ + +- 威注音版本：（請填寫版本） +- 注音排列與基礎鍵盤佈局：（在偏好設定視窗的「鍵盤設定」內可以查詢到） +- macOS 版本：（請填寫版本與建置編號，例：「13.0 (22A5321d)」） +- 在哪個應用程式中打字遇到問題：（應用程式名稱/版本） +- 電腦機種：（筆電或桌機，使用 Intel 或 Apple Silicon CPU） +- 其他特殊設備：（請填寫是否有外接螢幕、特製鍵盤如非標準美式鍵盤等） +- 特殊設定：（是否原本正常，改了某個系統設定後就遇到問題） + +**其他** +其他你覺得問題發生的疑點，或其他你想跟威注音開發團隊說的話。 diff --git a/.github/ISSUE_TEMPLATE/feature_requst.md b/.github/ISSUE_TEMPLATE/feature_requst.md new file mode 100644 index 00000000..6cda5548 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_requst.md @@ -0,0 +1,30 @@ +--- +name: 功能建議 +about: 告訴我們您還有什麼沒被滿足的需求 +title: "[功能建議]" +labels: "Q&A / DISCUSSION" +assignees: "" +--- + +**免責聲明** + +威注音輸入法保留拒絕任何種類的功能建議的權利（本來就有）。 + +閱讀來自各位使用者的功能建議請求，是一回事；**但**威注音研發方怎樣利用這些建議請求背後的潛在資訊、來制定威注音接下來的研發方向（或可能棄用相關想法），則是**另一回事**。 + +**痛點** +請告訴我們為什麼目前威注音沒辦法解決您的問題。您可以講一個能讓讀者得以感同身受的小故事，比如： + +- 我從 xx 年前開始，使用了 xx 輸入法，我相當依賴其中一項功能，但是威注音沒有... +- 一直以來我在輸入 xx 這類內容的時候，都很花時間，我想要有更有效率的辦法… + +**功能說明** +請大致說明您想要的功能，最後會看起來會像是怎樣。當然最簡單的說明可能會像是「跟 xxx 輸入法一樣」，但請您諒解，不是什麼人都用過你之前用過的那套輸入法（更何況像 mac 版漢音輸入法那樣的必須買來不一定能買得來的老機種＋灌上不一定能下載到的老系統才能重新體驗，成本很大），其他人想了解「跟 xxx 輸入法一樣」，首先還得找到那套輸入法，而且有些年代久遠的輸入法還找不到，這樣雙方的認知不同，會大幅降低溝通效率。 + +比方說，您想要某種符號表設計，或許可以提供我們一個草圖，或是其他你喜歡的輸入法的符號表的截圖。遇到某些更複雜的情境，您也可以考慮錄製螢幕畫面供大家參考。 + +**替代方案** +請問，您目前是用什麼方法，可以做到就算沒有這項功能，也可以達最後目的。或著，如果這項功能開發與其他功能衝突，您起碼可以接受什麼方案？ + +**其他** +其他你想跟威注音開發團隊說的話。 diff --git a/.github/ISSUE_TEMPLATE/phrase_report.md b/.github/ISSUE_TEMPLATE/phrase_report.md new file mode 100644 index 00000000..956aee92 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/phrase_report.md @@ -0,0 +1,24 @@ +--- +name: 原廠辭典問題提報 +about: 請告訴我們與原廠辭典有關的問題 +title: "[原廠辭典問題提報]" +labels: "BUG / DEBUFF / REGRESSION" +assignees: "" +--- + +### **請在開新的工單之前閱讀《[故障提報與用儀器捉蟲](https://vchewing.github.io/BUGREPORT.html)》按照裡面的方法先電郵聯絡、或至少在開工單之後電郵知會之。因各種可能原因，威注音的主程式師可能無法隨時收取 GitHub 與 Gitee 的工單提醒訊息。** + +### 請勿利用工單遞交**詞語新增請求**。所有「詞語新增請求」請一律使用電郵提報。 + +**分類** + +- [ ] 錯字或錯誤讀音 +- [ ] 缺字/詞 +- [ ] 字詞權重(優先級)問題 +- [ ] 其他 + +**說明** +請說明是哪個字寫錯或是標音錯誤，以及正確的寫法與念法。 + +**相關資料** +像是字典的連結等。