wangtinghu/agentUniverse
1
0
Fork 0
mirror of https://github.com/agentuniverse-ai/agentUniverse.git synced 2026-02-08 17:49:20 +08:00
Code Issues Packages Projects Releases Wiki Activity

chore: uodate CONTRIBUTING file

Browse Source
This commit is contained in:
Jerry Z H
2025-02-14 16:56:55 +08:00
parent a967ba96eb
commit 5c2fd96b86
3 changed files with 29 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
.github/pull-request-template.md vendored
View File

@@ -1,14 +1,12 @@
Please add one of the following labels to the Labels option on the right before creating the PR: [feat]、[fix]、[docs]、[refactor]、[test]、[chore].** | **请在创建PR前，在右侧 Labels 选项中加上label的其中一个: [feat]、[fix]、[docs]、[refactor]、[test]、[chore]。
**When submitting a PR, please confirm the following points and put [x] in the boxes one by one.** | **在提出pr时，请确认了以下几点，并逐一使用[x]符号确认勾选。**
**When submitting a PR, please confirm the following points and put [x] in the boxes one by one:** | **在提出pr时，请确认了以下几点，并逐一确认勾选：**
**Checklist:**
**Checklist | 检查项**
- [x] I have read and understood the [contributor guidelines](https://github.com/antgroup/agentUniverse/blob/master/CONTRIBUTING.md). | 我已阅读并理解[贡献者指南](https://github.com/antgroup/agentUniverse/blob/master/CONTRIBUTING_zh.md) 。
- [x] I have checked for any duplicate features related to this request and communicated with the project maintainers. | 我已检查没有与此请求重复的功能并与项目维护者进行了沟通。
- [x] I accept the suggestion of the maintainers to make changes to or close this PR. | 我接受此PR配合维护人员的建议进行修改或关闭。
- [] I have submitted the test files and can provide screenshots of the test results (required for feature or bug fixes) | 我已经提交了测试文件并可提供测试结果截图(功能修改、BUG修复类PR必须提供，其他按需)
- [] I have added or modified the documentation related to this PR | 我已经添加或修改了本次pr对应的文档说明(非必要，根据实际PR内容按需添加)
- [] I have added examples and notes if needed | 我已经添加了使用案例代码与文档说明(非必要，根据实际PR内容按需添加)
- [ ] I have submitted the test files and can provide screenshots of the test results (required for feature or bug fixes) | 我已经提交了测试文件并可提供测试结果截图(功能修改、BUG修复类PR必须提供，其他按需)
- [ ] I have added or modified the documentation related to this PR | 我已经添加或修改了本次pr对应的文档说明(非必要，根据实际PR内容按需添加)
- [ ] I have added examples and notes if needed | 我已经添加了使用案例代码与文档说明(非必要，根据实际PR内容按需添加)
**Please fill in the specific details of this PR:** | **请详细填写本次PR的内容:**

13
CONTRIBUTING.md
View File

@@ -18,6 +18,19 @@ Here is the list of commit types:
* test: Testing-related submissions or tools (e.g., test: add unit tests for agent loading module)
* chore: Other changes (e.g., chore: replace project icon image)
##### Guideline for PR
During the PR submission process, we follow the aforementioned commit types. You can choose the type as a PR label based on the main content of your submission.
Please ensure that you meet the following requirements when submitting your PR:
- Read and understand the requirements outlined in the [Contributor Guidelines](https://github.com/antgroup/agentUniverse/blob/master/CONTRIBUTING.md).
- Check for any duplicate features related to this request and communicated with the project maintainers.
- Accept the suggestion of the maintainers to make changes to or close this PR.
- Submit the test files and can provide screenshots of the test results (required for feature or bug fixes).
- Add or modified the documentation related to this PR.
- Add examples and notes if needed.
- Carefully fill out the PR request, including assigning maintainers, providing a detailed description of the PR content, and including necessary explanations and screenshots.
#### Guideline for development
We recommend following the [python PEP8](https://peps.python.org/pep-0008/) and [Google Python Style](https://google.github.io/styleguide/pyguide.html) guidelines.

12
CONTRIBUTING_zh.md
View File

@@ -18,7 +18,17 @@ commit类型列表：
* test: 测试类或工具提交 (如, test: 添加智能体加载模块单元测试)
* chore: 其他杂项 (如, chore: 项目icon图片替换)
同样在PR的提交过程中，我们沿用了上述类型，您可在PR提交中根据PR主要内容选择对应类型作为PR标签。
##### Pull Request规范
在PR的提交过程中，我们沿用了上述commit类型，您可在PR提交中根据主要内容选择对应类型作为PR标签。
请您确保在提交PR时满足如下要求：
- 阅读并理解[贡献者指南](https://github.com/antgroup/agentUniverse/blob/master/CONTRIBUTING_zh.md) 的要求。
- 检查没有与此PR请求重复的功能并与项目维护者进行了沟通。
- 接受PR配合维护人员的建议进行修改或关闭。
- 提交测试文件并提供测试结果截图(功能修改、BUG修复类PR必须提供，其他按需)
- 添加或修改本次pr对应的文档说明(非必要，根据实际PR内容按需添加)
- 添加使用案例代码与文档说明(非必要，根据实际PR内容按需添加)
- 认真填写PR请求，包括指定维护人员、详细描述PR内容、提供必要的说明与截图等
#### 研发规范参考
在代码与注释规范方面，本项目推荐采用[python PEP8](https://peps.python.org/pep-0008/) 与 [Google Python Style](https://google.github.io/styleguide/pyguide.html) 规范。