Преглед изворни кода

Chore: refactor issue template

Kr328 пре 3 година
родитељ
комит
de0cbd6b29

+ 25 - 20
.github/ISSUE_TEMPLATE/01-bug-report-en.yml

@@ -7,7 +7,7 @@ body:
       value: |
         Thanks for taking the time to fill out this bug report!
 
-        NOTE: Be sure to put a clear and concise title **AFTER** [BUG] in the text box above
+        NOTE: Be sure to put a clear and concise title **AFTER** `[BUG]` in the text box above.
 
         NOTE: We do not provide any services such as proxies, DO NOT feedback any problems not caused by this application here.
 
@@ -36,16 +36,16 @@ body:
     attributes:
       label: "Device Info"
       description: |
-        Input your device information according to the following format:
-        ```
-        - Device: [e.g Pixel 4]
-        - ROM: [e.g AOSP]
-        - Android Version: [e.g 10]
-        ```
-      placeholder: |
-        - Device: [e.g Pixel 4]
-        - ROM: [e.g AOSP]
-        - Android Version: [e.g 10]
+        Input your device information.
+
+        Example:
+        - Device: Pixel 4
+        - ROM: AOSP
+        - Android Version: 10
+      value: |
+        - Device:
+        - ROM:
+        - Android Version:
     validations:
       required: true
   - type: textarea
@@ -53,16 +53,18 @@ body:
     attributes:
       label: "Application Info"
       description: |
-        Input application you are using information according to the following format:
+        Input application you are using information.
+
+        Example:
         ```
-        - Version: [e.g 2.5.4-premium]
-        - APK filename: [e.g cfa-2.5.4-premium-arm64-v8a-release.apk]
-        - Distribution Channel: [e.g. Google Play]
+        - Version: 2.5.4-premium
+        - APK filename: cfa-2.5.4-premium-arm64-v8a-release.apk
+        - Distribution Channel: Google Play
         ```
-      placeholder: |
-        - Version: [e.g 2.5.4-premium]
-        - APK filename: [e.g cfa-2.5.4-premium-arm64-v8a-release.apk]
-        - Distribution Channel: [e.g. Google Play]
+      value: |
+        - Version:
+        - APK filename:
+        - Distribution Channel:
     validations:
       required: true
   - type: textarea
@@ -74,7 +76,9 @@ body:
 
         TIPS: If you only have a subscription link, please use your browser to download it.
 
-        NOTE: Please remove proxies from the configuration file before uploading it.
+        **NOTE: Please remove proxies from the configuration file before uploading it.**
+        **NOTE: Please remove proxies from the configuration file before uploading it.**
+        **NOTE: Please remove proxies from the configuration file before uploading it.**
     validations:
       required: true
   - type: textarea
@@ -83,6 +87,7 @@ body:
       label: "Logs"
       description: |
         Please paste or upload the log file here.
+
         TIPS: Please use the `Logcat` in application or `adb logcat`. `adb logcat` would be better.
     validations:
       required: true

+ 0 - 24
.github/ISSUE_TEMPLATE/02-feature-request-en.md

@@ -1,24 +0,0 @@
----
-name: "[English] Feature request"
-about: Suggest an idea for this app
-title: "[Feature Request] "
-labels: ''
-assignees: ''
-
----
-
-<!-- Be sure to put a clear title after [Feature Request] in the text box above -->
-<!-- Be sure to put a clear title after [Feature Request] in the text box above -->
-<!-- Be sure to put a clear title after [Feature Request] in the text box above -->
-
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Additional context**
-Add any other context or screenshots about the feature request here.

+ 22 - 0
.github/ISSUE_TEMPLATE/02-feature-request-en.yml

@@ -0,0 +1,22 @@
+name: "[English] Feature Request"
+description: "Create a report to help us improve"
+title: "[Feature Request] "
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this feature request!
+
+        NOTE: Be sure to put a clear and concise title **AFTER** `[Feature Request]` in the text box above.
+  - type: textarea
+    attributes:
+      label: "Feature Description"
+      description: |
+        A clear and concise description of the feature.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: "Additional"
+      description: |
+        Add any other context or screenshots about the feature request here.

+ 0 - 55
.github/ISSUE_TEMPLATE/03-bug-report-zh-cn.md

@@ -1,55 +0,0 @@
----
-name: "[简体中文] 创建错误报告"
-about: 创建错误报告以帮助我们改进应用
-title: "[BUG] "
-labels: ''
-assignees: ''
-
----
-
-<!-- 请务必在上方文本框处 [BUG] 后填入清晰明了的标题 -->
-<!-- 请务必在上方文本框处 [BUG] 后填入清晰明了的标题 -->
-<!-- 请务必在上方文本框处 [BUG] 后填入清晰明了的标题 -->
-
-**描述出现的错误**
-请简洁的描述你遇到的错误
-
-**如何复现该错误**
-复现步骤:
-1. ...
-2. ...
-3. ...
-4. ...
-
-**预期行为**
-清晰简单的描述你预期的应用应该表现的行为
-
-**屏幕截图**
-如果适用, 上传屏幕截图以帮助描述错误
-
-**设备信息 (请完成以下信息):**
- - 机型: [例如: Pixel 4]
- - 系统/ROM: [例如: MIUI 11]
- - Android 版本 [例如: 10]
- - ROM版本 [例如: 20.3.19]
-
-**应用信息**
- - 版本: [例如: 1.1.10]
- - 安装包文件名: [例如: app-release-arm64-v8a.apk]
- - 应用来源: [例如: Google Play]
-
-**附加信息**
-其他的可能与改错误相关的信息
-
-**配置文件**
-在此粘贴 **去除服务器信息的** 的 **配置文件**
-```yaml
-# 在此粘贴
-```
-
-**日志**
-粘贴日志以帮助侦测错误
-```
-<在此粘贴>
-```
-

+ 105 - 0
.github/ISSUE_TEMPLATE/03-bug-report-zh-cn.yml

@@ -0,0 +1,105 @@
+name: "[简体中文] 错误报告"
+description: "创建错误报告以帮助我们修正应用"
+title: "[BUG] "
+body:
+  - type: markdown
+    attributes:
+      value: |
+        感谢您在百忙之中填写此错误报告。
+
+        注意: 请务必在上方文本框的 `[BUG]` **之后**填写清晰明了的标题。
+
+        注意:这里不提供像是代理服务器之类的服务,请不要反馈非应用自身引起的问题。
+
+        <!-- template -->
+  - type: textarea
+    id: description
+    attributes:
+      label: "描述此错误"
+      description: "请清晰简洁的描述你遇到的错误。"
+    validations:
+      required: true
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: "如何复现该错误"
+      description: "复现步骤:"
+      value: |
+        步骤 1: ...
+        步骤 2: ...
+        步骤 3: ...
+        ...
+    validations:
+      required: true
+  - type: textarea
+    id: device-info
+    attributes:
+      label: "设备信息"
+      description: |
+        输入您正在使用的设备信息。
+
+        例子:
+        - 机型: Pixel 4
+        - 系统类型: MIUI/AOSP
+        - Android 版本: 10
+      value: |
+        - 机型:
+        - 系统类型:
+        - Android 版本:
+    validations:
+      required: true
+  - type: textarea
+    id: app-info
+    attributes:
+      label: "应用信息"
+      description: |
+        输入您正在使用的应用信息。
+
+        例子:
+        ```
+        - 版本: 2.5.4-premium
+        - 安装包文件名: cfa-2.5.4-premium-arm64-v8a-release.apk
+        - 应用来源: Google Play
+        ```
+      value: |
+        - 版本:
+        - 安装包文件名:
+        - 应用来源:
+    validations:
+      required: true
+  - type: textarea
+    id: configure
+    attributes:
+      label: "配置文件"
+      description: |
+        请在此粘贴和上传配置文件。
+
+        提示:如果您仅有一个订阅链接,请使用浏览器打开此链接以下载配置文件。
+
+        **注意: 请在上传配置文件前,移除其中的代理服务器信息。**
+        **注意: 请在上传配置文件前,移除其中的代理服务器信息。**
+        **注意: 请在上传配置文件前,移除其中的代理服务器信息。**
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: "日志"
+      description: |
+        请在此粘贴或上传日志。
+
+        提示: 请使用应用内的 `Logcat` 或 `adb logcat` 捕获日志. `adb logcat` 能更好地帮助侦测问题.
+    validations:
+      required: true
+  - type: textarea
+    id: screenshot
+    attributes:
+      label: "屏幕截图"
+      description: "如果适用,请在此粘贴或上传屏幕截图。"
+      placeholder: "可选"
+  - type: textarea
+    id: additional
+    attributes:
+      label: "附加信息"
+      description: "其他的可能与改错误相关的信息。"
+      placeholder: "可选"

+ 0 - 21
.github/ISSUE_TEMPLATE/04-feature-request-zh-cn.md

@@ -1,21 +0,0 @@
----
-name: "[简体中文] 功能请求"
-about: 你希望的能够在应用中增加的功能
-title: "[Feature Request] "
-labels: ''
-assignees: ''
-
----
-
-<!-- 请务必在上方文本框处 [Feature Request] 后填入清晰明了的标题 -->
-<!-- 请务必在上方文本框处 [Feature Request] 后填入清晰明了的标题 -->
-<!-- 请务必在上方文本框处 [Feature Request] 后填入清晰明了的标题 -->
-
-**功能描述**
-请清晰的描述你想要的功能
-
-**描述你希望的实现方式**
-清晰的描述应用应该如何实现该功能
-
-**附加信息**
-其他的与改功能相关的附加信息

+ 22 - 0
.github/ISSUE_TEMPLATE/04-feature-request-zh-cn.yml

@@ -0,0 +1,22 @@
+name: "[简体中文] 功能请求"
+description: "您希望的能够在应用中增加功能"
+title: "[Feature Request] "
+body:
+  - type: markdown
+    attributes:
+      value: |
+        感谢您在百忙之中填写此功能请求报告。
+
+        注意: 请务必在上方文本框的 `[Feature Request]` **之后**填写清晰明了的标题。
+  - type: textarea
+    attributes:
+      label: "功能描述"
+      description: |
+        简介明了的描述此功能。
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: "附加信息"
+      description: |
+        与此功能相关的其他附加信息。