做出贡献

Issue 规范

什么样的 issue 是不会被回复的

1. 在提出issue前，请查看您的提出的问题是否已经在 issue 列表或者 discussion 内出现，提出重复的问题将 被关闭 。
2. 非项目推荐配置的任何关于环境配置问题的 issue 通常将 不会由官方回复，请您在微信沟通群内咨询。
3. 与项目无关的 issue 将 不会被回复 。
4. 超过30天没有更新动态的 issue 将 被关闭 。
5. 语言非中文和英语的 issue 将 被关闭 。
6. 没有尝试过解决方案的 issue 将 被关闭 。
7. 没有提出任何贡献（例如PR，论文）的 feature / enhancement 将会 被关闭 。您可以在 discussion 中的 希望开发的功能 讨论区中留言，我们开发组会进行回复。
8. 不按照 Issue 规范提出的 issue 可能将 被关闭 。

如何提 issue

1. 简要阐述你的问题
2. 配上报错日志以(运行报错)或者运行不理想的效果图(原本期望和现实的)
3. 配上对应的配置文件以你的环境
4. 你尝试过的解决方法。（非常重要）
5. 按照模板提出Issue

PR 规范

什么样的 PR 是不会被接受的

1. 非紧急bug修复的PR并直接提交到master的PR。
2. 仅仅修改Readme.md和配置文件的。
3. 跟项目组已经开发的内容冲突的(dev版本)，将可能被拒绝。

首先请注意所有的PR需要以dev分支为基准，master分支仅用来发行与紧急bug修复。

提出新的通用自定义分词器

1. 将您的分词器所在的代码文件放在text_splitter文件夹下，文件名为您的分词器名字my_splitter.py，然后在__init__.py中导入您的分词器。
2. 发起PR，并说明您的分词器面向的场景或者改进之处。我们非常期待您能举例一个具体的应用场景。

提出新的 Agent 工具

1. 将您的Agent工具所在的代码放在 server/agent文件夹下，文件名为您的工具名字my_tools.py，然后在tools.py中导入您的工具。
2. 发起PR，说明您的工具面向的场景或改进之处，并说明如何进行测试和调用。我们非常期待您能举例一个具体的应用场景。

提出新的自定义模型

1. 将您的模型贡献到huggingface平台上，并开放给开发人员下载。
2. 发起PR，说明您的工具面向的场景或改进之处，并说明如何进行测试和调用。我们非常期待您能举例一个具体的应用场景。
3. 由开发人员测试通过后，将您的模型添加到合作模型名单中。

修复 Bug & 增加其他新功能

1. 一个 PR 中必须 只有一个或者一类功能增加，或者修复一个bug ，多个功能混合的 PR 将 不会被接受 。
2. 说明您增加的功能或者改进之处，并说明如何进行测试和调用。我们非常期待您能举例一个具体的应用场景。