diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..f4c2151 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,70 @@ +name: Bug 反馈 +description: 在使用过程中遇到了 Bug +title: "[BUG]: " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + 感谢您进行 Bug 反馈。请起一个能够清晰描述您的问题的标题，便于开发者解决您的问题。 + + - type: markdown + attributes: + value: | + ## Bug 信息 + + 描述您遇到的 Bug。您可以附上截图、相关代码、堆栈跟踪等材料，便于开发者追踪问题。 + + - type: textarea + id: about_info + attributes: + label: 相关信息 + description: 报错信息 + validations: + required: true + + - type: textarea + id: about_code + attributes: + label: 相关代码 + description: 发生报错的相关代码（请注意隐藏隐私信息） + render: python + validations: + required: false + + - type: textarea + id: stacktrace + attributes: + label: 堆栈跟踪 + description: 请将产生的堆栈跟踪信息粘贴到此处，便于开发者定位 Bug。 + render: shell + + - type: input + id: python_version + attributes: + label: Python 版本 + description: 您当前使用的 Python 版本号 + placeholder: 如：0.3.0 + validations: + required: true + + - type: dropdown + id: runtime_environment + attributes: + label: 运行环境 + description: 程序运行环境 + options: + - Windows + - MacOS + - Linux + validations: + required: true + + - type: checkboxes + id: revision + attributes: + label: 最后一步 + description: 回顾您的回答 + options: + - label: 我认为上述的描述已经足以详细，以允许开发人员能复现该问题。如果我的 Issue 没有按照上述的要求填写，可能会被 **无条件关闭**。 + required: true diff --git a/.github/ISSUE_TEMPLATE/bug_en.yml b/.github/ISSUE_TEMPLATE/bug_en.yml new file mode 100644 index 0000000..23807b0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_en.yml @@ -0,0 +1,70 @@ +name: Bug Report +description: Report a bug you encountered during use +title: "[BUG]: " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thank you for reporting a bug. Please choose a title that clearly describes your issue to help developers resolve it effectively. + + - type: markdown + attributes: + value: | + ## Bug Details + + Describe the bug you encountered. You may attach screenshots, relevant code, stack traces, etc., to help developers track down the issue. + + - type: textarea + id: about_info + attributes: + label: Error Information + description: Error messages you encountered + validations: + required: true + + - type: textarea + id: about_code + attributes: + label: Related Code + description: The relevant code where the error occurred (please be sure to hide any sensitive information) + render: python + validations: + required: false + + - type: textarea + id: stacktrace + attributes: + label: Stack Trace + description: Paste the generated stack trace here to help developers locate the bug. + render: shell + + - type: input + id: python_version + attributes: + label: Python Version + description: The version of Python you are currently using + placeholder: e.g., 0.3.0 + validations: + required: true + + - type: dropdown + id: runtime_environment + attributes: + label: Runtime Environment + description: The environment in which the program is running + options: + - Windows + - MacOS + - Linux + validations: + required: true + + - type: checkboxes + id: revision + attributes: + label: Final Step + description: Review your answers + options: + - label: I believe the above description is detailed enough to allow developers to reproduce the issue. If my issue does not meet the above requirements, it may be **closed unconditionally**. + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..0086358 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 0000000..73ad1d9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,34 @@ +name: 提交需求/新功能 +description: 使用该模板进行提交需求/新功能 +title: "[Feature]:" +labels: ["feature"] +body: + - type: markdown + attributes: + value: | + 感谢您进行功能请求。请起一个能够清晰描述您的请求的标题，便于开发者完成您的请求。 + + - type: textarea + id: describe + attributes: + label: 功能描述 + description: 描述请求的功能 + validations: + required: true + + - type: textarea + id: expect + attributes: + label: 预期结果 + description: 想要实现的功能效果 + validations: + required: false + + - type: checkboxes + id: revision + attributes: + label: 最后一步 + description: 回顾您的回答 + options: + - label: 我认为上述的描述已经足以详细，以允许开发人员能完成功能。如果我的 Issue 没有按照上述的要求填写，可能会被 **无条件关闭**。 + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_en.yml b/.github/ISSUE_TEMPLATE/feature_en.yml new file mode 100644 index 0000000..4615bbd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_en.yml @@ -0,0 +1,34 @@ +name: Feature Request +description: Use this template to submit feature requests +title: "[Feature]:" +labels: ["feature"] +body: + - type: markdown + attributes: + value: | + Thank you for submitting a feature request. Please choose a title that clearly describes your request to help developers fulfill it effectively. + + - type: textarea + id: describe + attributes: + label: Feature Description + description: Describe the feature you are requesting + validations: + required: true + + - type: textarea + id: expect + attributes: + label: Expected Outcome + description: The desired effect or behavior of the requested feature + validations: + required: false + + - type: checkboxes + id: revision + attributes: + label: Final Step + description: Review your answers + options: + - label: I believe the above description is detailed enough to allow developers to implement the feature. If my issue does not meet the above requirements, it may be **closed unconditionally**. + required: true diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..0c9dabb --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,14 @@ + + +### 🔗 相关 Issue | Related Issue + + + +