mirror of
https://github.com/agentscope-ai/ReMe.git
synced 2026-10-10 03:30:56 +00:00
change contribute doc
This commit is contained in:
parent
993c48cdca
commit
8b4ccb6f3f
3 changed files with 8 additions and 26 deletions
|
|
@ -103,16 +103,13 @@ MemoryScope可以用于个人助理、情感陪伴等记忆场景,通过长期
|
|||
|
||||
|
||||
## 💡 代码贡献
|
||||
|
||||
欢迎社区的代码贡献。
|
||||
|
||||
我们非常推荐每一个贡献者在代码提交前,安装`pre-commit`钩子工具,
|
||||
能够帮助在每一次git提交的时候,进行自动化的代码格式校验。
|
||||
```shell
|
||||
poetry install --with dev
|
||||
pip install -e .
|
||||
pre-commit install
|
||||
```
|
||||
|
||||
请参阅我们的[贡献指南](./docs/contribute_zh.md) 了解更多详细信息。
|
||||
|
||||
## 📖 引用
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ git clone https://github.com/your-username/memoryscope.git
|
|||
cd memoryscope
|
||||
```
|
||||
### Create a New Branch
|
||||
Create a new branch for your work. This helps keep proposed changes organized and separate from the `master` branch.
|
||||
Create a new branch for your work. This helps keep proposed changes organized and separate from the `main` branch.
|
||||
```bash
|
||||
git checkout -b your-feature-branch-name
|
||||
```
|
||||
|
|
@ -36,7 +36,7 @@ git commit -m "A brief description of the changes"
|
|||
```
|
||||
You might get some error messages raised by `pre-commit`. Please resolve them according to the error code and commit again.
|
||||
### Submit a Pull Request
|
||||
When you're ready for feedback, submit a pull request to the MemoryScope `master` branch. In your pull request description, explain the changes you've made and any other relevant context.
|
||||
When you're ready for feedback, submit a pull request to the MemoryScope `main` branch. In your pull request description, explain the changes you've made and any other relevant context.
|
||||
We will review your pull request. This process might involve some discussion, additional changes on your part, or both.
|
||||
### Code Review
|
||||
Wait for us to review your pull request. We may suggest some changes or improvements. Keep an eye on your GitHub notifications and be responsive to any feedback.
|
||||
Wait for us to review your pull request. We may suggest some changes or improvements. Keep an eye on your GitHub notifications and be responsive to any feedback.
|
||||
|
|
|
|||
|
|
@ -1,42 +1,27 @@
|
|||
# 贡献到MemoryScope
|
||||
|
||||
我们的社区因其成员的多样化思想和贡献而兴旺发展。无论是修复一个错误,添加一个新功能,改进文档,还是添加示例,我们都欢迎您的帮助。以下是您做出贡献的方法:
|
||||
|
||||
## 报告错误和提出新功能
|
||||
|
||||
当您发现一个错误或者有一个功能请求,请首先检查问题跟踪器,查看它是否已经被报告。如果没有,随时可以开设一个新的问题。请包含尽可能多的细节:
|
||||
|
||||
- 简明扼要的标题
|
||||
- 清晰地描述问题
|
||||
- 提供重现问题的步骤
|
||||
- 提供所使用的MemoryScope版本
|
||||
- 提供所有相关代码片段或错误信息
|
||||
|
||||
## 对代码库做出贡献
|
||||
|
||||
### Fork和Clone仓库
|
||||
|
||||
要处理一个问题或新功能,首先要Fork仓库,然后将你的Fork克隆到本地。
|
||||
|
||||
```bash
|
||||
git clone git@github.com:modelscope/MemoryScope.git
|
||||
cd MemoryScope
|
||||
```
|
||||
|
||||
### 创建一个新分支
|
||||
|
||||
为您的工作创建一个新分支。这有助于保持拟议更改的组织性,并与`master`分支分离。
|
||||
|
||||
为您的工作创建一个新分支。这有助于保持拟议更改的组织性,并与`main`分支分离。
|
||||
```bash
|
||||
git checkout -b your-feature-branch-name
|
||||
```
|
||||
|
||||
### 做出修改
|
||||
|
||||
创建您的新分支后就可以对代码进行修改了。请注意如果您正在解决多个问题或实现多个功能,最好为每个问题或功能创建单独的分支和拉取请求。
|
||||
|
||||
我们提供了一个开发者版本,与官方版本相比,它附带了额外的pre-commit钩子以执行格式检查:
|
||||
|
||||
我们非常推荐每一个贡献者在代码提交前,安装`pre-commit`钩子工具,
|
||||
能够帮助在每一次git提交的时候,进行自动化的代码格式校验。
|
||||
```bash
|
||||
# 安装开发者版本
|
||||
pip install -e .
|
||||
|
|
@ -57,7 +42,7 @@ git commit -m "修改内容的简要描述"
|
|||
|
||||
### 提交 Pull Request
|
||||
|
||||
当您准备好您的修改分支后,向MemoryScope的 `master` 分支提交一个Pull Request。在您的Pull Request描述中,解释您所做的修改以及其他相关的信息。
|
||||
当您准备好您的修改分支后,向MemoryScope的 `main` 分支提交一个Pull Request。在您的Pull Request描述中,解释您所做的修改以及其他相关的信息。
|
||||
|
||||
我们将审查您的Pull Request。这个过程可能涉及一些讨论以及额外的代码修改。
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue