Skip to content

Commit a9ffe4f

Browse files
authored
feat: update issue and pr templates (#98)
1 parent 29b19a0 commit a9ffe4f

File tree

4 files changed

+73
-31
lines changed

4 files changed

+73
-31
lines changed
Lines changed: 46 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,64 @@
1-
name: "\U0001F41B Bug / help"
2-
description: Create a report to help us improve MemOS
1+
name: "\U0001F41B Bug Report"
2+
description: Report a bug to help us improve MemOS | 报告错误以帮助我们改进 MemOS
3+
title: "fix: "
34
labels: ["bug", "pending"]
45
body:
56

7+
- type: checkboxes
8+
id: checklist
9+
attributes:
10+
label: Pre-submission checklist | 提交前检查
11+
options:
12+
- label: I have searched existing issues and this hasn't been mentioned before | 我已搜索现有问题,确认此问题尚未被提及
13+
required: true
14+
- label: I have read the project documentation and confirmed this issue doesn't already exist | 我已阅读项目文档并确认此问题尚未存在
15+
required: true
16+
- label: This issue is specific to MemOS and not a general software issue | 该问题是针对 MemOS 的,而不是一般软件问题
17+
required: true
18+
619
- type: textarea
7-
id: system-info
20+
id: description
21+
attributes:
22+
label: "Bug Description | 问题描述"
23+
placeholder: "Describe what happened and what you expected to happen"
824
validations:
925
required: true
10-
attributes:
11-
label: System Info
12-
description: |
13-
Please share your system info with us. You can run the command **pip show MemoryOS** and copy-paste its output below.
14-
请提供您的系统信息。您可以在命令行运行 **pip show MemoryOS** 并将其输出复制到该文本框中。
15-
16-
placeholder: MemoryOS version, platform, python version, ...
1726

1827
- type: textarea
1928
id: reproduction
29+
attributes:
30+
label: "How to Reproduce | 如何重现"
31+
placeholder: |
32+
1. Import/run '...'
33+
2. Call function '...'
34+
3. See error
2035
validations:
2136
required: true
22-
attributes:
23-
label: Reproduction
24-
description: |
25-
Please provide entry arguments, error messages and stack traces that reproduces the problem.
26-
请提供入口参数,错误日志以及异常堆栈以便于我们复现问题。
2737

28-
value: |
29-
```text
30-
Put your message here.
31-
```
38+
- type: textarea
39+
id: environment
40+
attributes:
41+
label: "Environment | 环境信息"
42+
placeholder: |
43+
- Python version:
44+
- Operating System:
45+
- MemOS version: (run `pip show memoryos`)
46+
validations:
47+
required: true
3248

3349
- type: textarea
3450
id: others
3551
validations:
3652
required: false
3753
attributes:
38-
label: Others
54+
label: "Additional Context | 其他信息"
55+
56+
- type: checkboxes
57+
id: contribution
58+
attributes:
59+
label: Willingness to Implement | 实现意愿
60+
options:
61+
- label: I'm willing to implement this myself | 我愿意自己解决
62+
required: false
63+
- label: I would like someone else to implement this | 我希望其他人来解决
64+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: "\U0001F527 GitHub Pull Requests"
4+
url: https://github.com/MemTensor/MemOS/pulls
5+
about: Contribute code improvements via Pull Requests | 通过 Pull Requests 贡献代码改进
6+
- name: "\U0001F4AC GitHub Discussions"
7+
url: https://github.com/MemTensor/MemOS/discussions
8+
about: Participate in our GitHub Discussions to ask questions or share ideas | 加入 GitHub Discussions,提出问题或分享想法
9+
- name: "\U0001F3AE Discord Server"
10+
url: https://discord.gg/Txbx3gebZR
11+
about: Join our Discord Server for real-time community chat | 加入我们的 Discord 服务器进行实时社区聊天
12+
- name: "\U0001F4F1 WeChat Group"
13+
url: https://statics.memtensor.com.cn/memos/qr-code.png
14+
about: Scan the QR code to join our WeChat group for more discussions | 扫描二维码加入我们的微信群,进行更多讨论
Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,37 @@
11
name: "\U0001F680 Feature request"
2-
description: Submit a request for a new feature
2+
description: Submit a request for a new feature | 申请添加新功能
3+
title: "feat: "
34
labels: ["enhancement", "pending"]
45
body:
6+
57
- type: checkboxes
68
id: checklist
79
attributes:
8-
label: Pre-submission checklist
10+
label: Pre-submission checklist | 提交前检查
911
options:
10-
- label: I have searched existing issues and this feature hasn't been requested before | 我已搜索现有问题,确认此功能尚未被请求
12+
- label: I have searched existing issues and this hasn't been mentioned before | 我已搜索现有问题,确认此问题尚未被提及
1113
required: true
12-
- label: I have read the project documentation and confirmed this feature doesn't already exist | 我已阅读项目文档并确认此功能尚未存在
14+
- label: I have read the project documentation and confirmed this issue doesn't already exist | 我已阅读项目文档并确认此问题尚未存在
1315
required: true
14-
- label: This feature request is specific to MemOS and not a general software issue | 该功能请求是针对 MemOS 的,而不是一般软件问题
16+
- label: This issue is specific to MemOS and not a general software issue | 该问题是针对 MemOS 的,而不是一般软件问题
1517
required: true
1618

1719
- type: textarea
1820
id: problem
1921
validations:
2022
required: true
2123
attributes:
22-
label: Problem Statement
24+
label: Problem Statement | 问题陈述
2325
placeholder: |
2426
Describe the problem you're trying to solve...
2527
Example: "As a developer using MemOS, I find it difficult to..."
2628
2729
- type: checkboxes
2830
id: contribution
2931
attributes:
30-
label: Implementation Contribution
32+
label: Willingness to Implement | 实现意愿
3133
options:
32-
- label: I'm willing to implement this feature myself | 我愿意自己实现此功能
34+
- label: I'm willing to implement this myself | 我愿意自己解决
3335
required: false
34-
- label: I would like someone else to implement this | 我希望其他人来实现此功能
36+
- label: I would like someone else to implement this | 我希望其他人来解决
3537
required: false

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44
Please include a summary of the changes below;
55
Fill in the issue number that this PR addresses (if applicable);
66
Mention the person who will review this PR (if you know who it is);
7-
Replace (summary), (issue), and (reviewer) with the appropriate information (No parentheses).
7+
Replace (summary), (issue), and (reviewer) with the appropriate information.
88
99
请在下方填写更改的摘要;
1010
填写此 PR 解决的问题编号(如果适用);
1111
提及将审查此 PR 的人(如果您知道是谁);
12-
替换 (summary)、(issue) 和 (reviewer) 为适当的信息(不带括号)
12+
替换 (summary)、(issue) 和 (reviewer) 为适当的信息。
1313
-->
1414

1515
Summary: (summary)

0 commit comments

Comments
 (0)