Langchain-Chatchat/docs/contributing
weiweiw 1ea399bec7 first commit 2024-12-20 16:04:03 +08:00
..
README.md first commit 2024-12-20 16:04:03 +08:00
README_dev.md first commit 2024-12-20 16:04:03 +08:00
agent.md first commit 2024-12-20 16:04:03 +08:00
api.md first commit 2024-12-20 16:04:03 +08:00
code.md first commit 2024-12-20 16:04:03 +08:00
repo_structure.md first commit 2024-12-20 16:04:03 +08:00
settings.md first commit 2024-12-20 16:04:03 +08:00

README.md

贡献指南

各位开发者Langchain-Chatchat 由个人组织经过了不断地迭代和完善,作为一个不断进化的项目, 我们欢迎您的参与无论是提交bug报告、功能请求、代码贡献、文档编写、测试、或者其他形式的贡献。

贡献方式

这里列出了一些您可以为 Langchain-Chatchat 做出贡献的方式:

  • Code: 帮助我们编写代码修复bug或者改进基础设施。
  • Documentation: 帮助我们编写文档,使 chatchat 更容易使用。
  • Discussions: 帮助回答用户的使用问题,讨论问题。 当您的贡献被接受,并在 master 分支生效后,您的名字将会自动被添加到贡献者列表中。

Github Issue

我们需要跟踪功能请求与 Bug 报告

目前我们有使用 Issue 默认模板来让用户更好的描述问题,但是目前这个大部分 Issue 的用户可能依然选择只回复一句话,

对于这样的情况我们需要告知用户如何更好的描述问题。在 15 天内没有回复的 Issue 我们会关闭 Issue。

关于功能请求备受关注的RAG话题我们会考虑加入到我们的开发计划中。

我们努力保持 Issue 的更新,但是我们也需要您的帮助,如果您发现有问题没有得到及时回复,请在 Issue 下@我们。

寻求帮助

我们尽量使开发者更容易上手,当您遇到问题时,请联系维护人员,我们会尽力帮助您。

类似的 diff、formatting、linting、testing等问题如果您不确定如何解决请随时联系我们 很多时候规则校验会阻碍一些开发者,您的思路如果足够优秀,我们会考虑调整规则。