From 5617ebafb35cee9c706ccf9da154060192439fbd Mon Sep 17 00:00:00 2001 From: Shichao Song <60967965+Ki-Seki@users.noreply.github.com> Date: Wed, 16 Jul 2025 14:02:30 +0800 Subject: [PATCH] feat: update issue and pr templates --- .github/ISSUE_TEMPLATE/bug-report.yml | 66 +++++++++++++++------- .github/ISSUE_TEMPLATE/config.yml | 14 +++++ .github/ISSUE_TEMPLATE/feature-request.yml | 20 ++++--- .github/PULL_REQUEST_TEMPLATE.md | 4 +- 4 files changed, 73 insertions(+), 31 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index b1d91624a..31c3ca656 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,38 +1,64 @@ -name: "\U0001F41B Bug / help" -description: Create a report to help us improve MemOS +name: "\U0001F41B Bug Report" +description: Report a bug to help us improve MemOS | 报告错误以帮助我们改进 MemOS +title: "fix: " labels: ["bug", "pending"] body: + - type: checkboxes + id: checklist + attributes: + label: Pre-submission checklist | 提交前检查 + options: + - label: I have searched existing issues and this hasn't been mentioned before | 我已搜索现有问题，确认此问题尚未被提及 + required: true + - label: I have read the project documentation and confirmed this issue doesn't already exist | 我已阅读项目文档并确认此问题尚未存在 + required: true + - label: This issue is specific to MemOS and not a general software issue | 该问题是针对 MemOS 的，而不是一般软件问题 + required: true + - type: textarea - id: system-info + id: description + attributes: + label: "Bug Description | 问题描述" + placeholder: "Describe what happened and what you expected to happen" validations: required: true - attributes: - label: System Info - description: | - Please share your system info with us. You can run the command **pip show MemoryOS** and copy-paste its output below. - 请提供您的系统信息。您可以在命令行运行 **pip show MemoryOS** 并将其输出复制到该文本框中。 - - placeholder: MemoryOS version, platform, python version, ... - type: textarea id: reproduction + attributes: + label: "How to Reproduce | 如何重现" + placeholder: | + 1. Import/run '...' + 2. Call function '...' + 3. See error validations: required: true - attributes: - label: Reproduction - description: | - Please provide entry arguments, error messages and stack traces that reproduces the problem. - 请提供入口参数，错误日志以及异常堆栈以便于我们复现问题。 - value: | - ```text - Put your message here. - ``` + - type: textarea + id: environment + attributes: + label: "Environment | 环境信息" + placeholder: | + - Python version: + - Operating System: + - MemOS version: (run `pip show memoryos`) + validations: + required: true - type: textarea id: others validations: required: false attributes: - label: Others + label: "Additional Context | 其他信息" + + - type: checkboxes + id: contribution + attributes: + label: Willingness to Implement | 实现意愿 + options: + - label: I'm willing to implement this myself | 我愿意自己解决 + required: false + - label: I would like someone else to implement this | 我希望其他人来解决 + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..8b3604a00 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: "\U0001F527 GitHub Pull Requests" + url: https://github.com/MemTensor/MemOS/pulls + about: Contribute code improvements via Pull Requests | 通过 Pull Requests 贡献代码改进 + - name: "\U0001F4AC GitHub Discussions" + url: https://github.com/MemTensor/MemOS/discussions + about: Participate in our GitHub Discussions to ask questions or share ideas | 加入 GitHub Discussions，提出问题或分享想法 + - name: "\U0001F3AE Discord Server" + url: https://discord.gg/Txbx3gebZR + about: Join our Discord Server for real-time community chat | 加入我们的 Discord 服务器进行实时社区聊天 + - name: "\U0001F4F1 WeChat Group" + url: https://statics.memtensor.com.cn/memos/qr-code.png + about: Scan the QR code to join our WeChat group for more discussions | 扫描二维码加入我们的微信群，进行更多讨论 diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index ed17b4109..b441250fa 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -1,17 +1,19 @@ name: "\U0001F680 Feature request" -description: Submit a request for a new feature +description: Submit a request for a new feature | 申请添加新功能 +title: "feat: " labels: ["enhancement", "pending"] body: + - type: checkboxes id: checklist attributes: - label: Pre-submission checklist + label: Pre-submission checklist | 提交前检查 options: - - label: I have searched existing issues and this feature hasn't been requested before | 我已搜索现有问题，确认此功能尚未被请求 + - label: I have searched existing issues and this hasn't been mentioned before | 我已搜索现有问题，确认此问题尚未被提及 required: true - - label: I have read the project documentation and confirmed this feature doesn't already exist | 我已阅读项目文档并确认此功能尚未存在 + - label: I have read the project documentation and confirmed this issue doesn't already exist | 我已阅读项目文档并确认此问题尚未存在 required: true - - label: This feature request is specific to MemOS and not a general software issue | 该功能请求是针对 MemOS 的，而不是一般软件问题 + - label: This issue is specific to MemOS and not a general software issue | 该问题是针对 MemOS 的，而不是一般软件问题 required: true - type: textarea @@ -19,7 +21,7 @@ body: validations: required: true attributes: - label: Problem Statement + label: Problem Statement | 问题陈述 placeholder: | Describe the problem you're trying to solve... Example: "As a developer using MemOS, I find it difficult to..." @@ -27,9 +29,9 @@ body: - type: checkboxes id: contribution attributes: - label: Implementation Contribution + label: Willingness to Implement | 实现意愿 options: - - label: I'm willing to implement this feature myself | 我愿意自己实现此功能 + - label: I'm willing to implement this myself | 我愿意自己解决 required: false - - label: I would like someone else to implement this | 我希望其他人来实现此功能 + - label: I would like someone else to implement this | 我希望其他人来解决 required: false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f532a0c42..fbc6dabcf 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -4,12 +4,12 @@ Please include a summary of the changes below; Fill in the issue number that this PR addresses (if applicable); Mention the person who will review this PR (if you know who it is); -Replace (summary), (issue), and (reviewer) with the appropriate information (No parentheses). +Replace (summary), (issue), and (reviewer) with the appropriate information. 请在下方填写更改的摘要； 填写此 PR 解决的问题编号（如果适用）； 提及将审查此 PR 的人（如果您知道是谁）； -替换 (summary)、(issue) 和 (reviewer) 为适当的信息（不带括号）。 +替换 (summary)、(issue) 和 (reviewer) 为适当的信息。 --> Summary: (summary)