Skip to content

Commit 99c052c

Browse files
authored
ci: add issue templates, update pull request template, etc. (#17)
* ci: Add issue templates for bug reports and feature requests; update pull request template and GitHub Actions workflow * docs: Add CONTRIBUTING guidelines to the repository * docs: Update contribution guidelines link in README
1 parent 2e6f6e8 commit 99c052c

File tree

6 files changed

+94
-34
lines changed

6 files changed

+94
-34
lines changed

.github/CONTRIBUTING

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Please read https://memos.openmem.net/docs/contribution/overview to learn how to contribute to this repository. 🌟
2+
3+
请阅读 https://memos.openmem.net/docs/contribution/overview 了解如何为此项目贡献代码。🌟
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: "\U0001F41B Bug / help"
2+
description: Create a report to help us improve MemOS
3+
labels: ["bug", "pending"]
4+
body:
5+
6+
- type: textarea
7+
id: system-info
8+
validations:
9+
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, ...
17+
18+
- type: textarea
19+
id: reproduction
20+
validations:
21+
required: true
22+
attributes:
23+
label: Reproduction
24+
description: |
25+
Please provide entry arguments, error messages and stack traces that reproduces the problem.
26+
请提供入口参数,错误日志以及异常堆栈以便于我们复现问题。
27+
28+
value: |
29+
```text
30+
Put your message here.
31+
```
32+
33+
- type: textarea
34+
id: others
35+
validations:
36+
required: false
37+
attributes:
38+
label: Others
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: "\U0001F680 Feature request"
2+
description: Submit a request for a new feature
3+
labels: ["enhancement", "pending"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Please do not create issues that are not related to new features under this category.
9+
请勿在此分类下创建和新特性无关的 issues。
10+
11+
- type: checkboxes
12+
id: reminder
13+
attributes:
14+
label: Reminder
15+
description: |
16+
Please ensure you have read the above rules carefully and searched the existing issues.
17+
请确保您已经认真阅读了上述规则并且搜索过现有的 issues。
18+
19+
options:
20+
- label: I have read the above rules and searched the existing issues.
21+
required: true
22+
23+
- type: textarea
24+
id: description
25+
validations:
26+
required: true
27+
attributes:
28+
label: Description
29+
description: |
30+
A clear and concise description of the feature proposal.
31+
请详细描述您希望加入的新功能特性。
32+
33+
- type: textarea
34+
id: contribution
35+
validations:
36+
required: false
37+
attributes:
38+
label: Pull Request
39+
description: |
40+
Have you already created the relevant PR and submitted the code?
41+
您是否已经创建了相关 PR 并提交了代码?

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 8 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,14 @@
11
## Description
22

3-
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
3+
> Please include a summary of the change and which issue is fixed.
4+
>
5+
> 请介绍你的修改,并说明它修复了哪个 issue.
46
5-
Fixes # (issue)
6-
7-
## Type of change
8-
9-
Please delete options that are not relevant.
10-
11-
- [ ] Bug fix (non-breaking change which fixes an issue)
12-
- [ ] New feature (non-breaking change which adds functionality)
13-
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14-
- [ ] Refactor (does not change functionality, e.g. code style improvements, linting)
15-
- [ ] Documentation update
16-
17-
## How Has This Been Tested?
18-
19-
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
20-
21-
Please delete options that are not relevant.
22-
23-
- [ ] Unit Test
24-
- [ ] Test Script (please provide)
7+
Fix # (issue)
258

269
## Checklist:
2710

28-
- [ ] My code follows the style guidelines of this project
29-
- [ ] I have performed a self-review of my own code
30-
- [ ] I have commented my code, particularly in hard-to-understand areas
31-
- [ ] My changes generate no new warnings
32-
- [ ] I have added tests that prove my fix is effective or that my feature works
33-
- [ ] New and existing unit tests pass locally with my changes
34-
- [ ] I have checked my code and corrected any misspellings
35-
36-
## Maintainer Checklist
37-
38-
- [ ] closes #xxxx (Replace xxxx with the GitHub issue number)
39-
- [ ] Made sure Checks passed
11+
- [ ] I have performed a self-review of my own code | 我已自行检查了自己的代码
12+
- [ ] I have commented my code, particularly in hard-to-understand areas | 我已对代码进行了注释,特别是在难以理解的地方
13+
- [ ] I have added tests that prove my fix is effective or that my feature works | 我已添加测试以证明我的修复有效或功能正常
14+
- [ ] I have added necessary documentation (if appropriate) | 我已添加必要的文档(如果有必要)

.github/workflows/python-tests.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33

44
name: Python tests
55

6+
permissions:
7+
contents: read
8+
69
on:
710
push:
811
branches:

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ If you use MemOS in your research, please cite our paper:
209209

210210
## 🙌 Contributing
211211

212-
We welcome contributions from the community! Please read our [contribution guidelines](./docs/contribution/overview.md) to get started.
212+
We welcome contributions from the community! Please read our [contribution guidelines](https://memos.openmem.net/docs/contribution/overview) to get started.
213213

214214
## 📄 License
215215

0 commit comments

Comments
 (0)