我们欢迎所有贡献、错误报告、错误修复、文档改进、增强功能和想法。
入门指南#
以下是一些帮助您开始为 Chroma 做出贡献的有用链接:
- Chroma 代码库托管在 Github 上。
- 问题在 Github Issues 上跟踪。请在那里报告您发现的任何问题,确保填写正确的问题类型表单。
- 要在本地运行 Chroma,您可以按照 开发指南 进行操作。
- 如果您想贡献但不确定从哪里开始,可以搜索带有 Good first issue 标签的问题,或者查看我们的 路线图。
- Chroma 文档(包括此页面!)也托管在 Github 上。如果您发现文档有问题,请在文档的 Github Issues 页面上报告 这里。
贡献代码和想法#
拉取请求#
为了提交对 Chroma 的更改,请提交一个 Pull Request 针对 Chroma 或文档。Pull Request 将由 Chroma 团队审核,如果获得批准,将被合并到仓库中。我们将尽力及时审核 Pull Request,但请耐心等待,因为我们是一个小团队。如果您的提议更改符合项目的宗旨,我们将尽快整合。我们要求您在 Pull Request 标题前加上一个前缀,以表明您提议的更改类型。以下是使用的前缀:
CIPs#
Chroma 改进提案或 CIPs(发音为“Chips”)是提议新功能或对 Chroma 进行重大更改的方式。如果您计划对 Chroma 进行重大更改,请先提交一个 CIP,以便 Chroma 核心团队和社区可以讨论提议的更改并提供反馈。CIP 应提供该功能的简洁技术规范,并说明其必要性。CIP 应作为 Pull Request 提交到 CIPs 文件夹。CIP 将由 Chroma 团队审核,如果获得批准,将被合并到仓库中。要了解更多关于编写 CIP 的信息,您可以阅读 指南。CIP 对于小更改(如错误修复或文档更新)不是必需的。
CIP 从“Proposed”状态开始,一旦 Chroma 团队审核并考虑实施,它将进入“Under Review”状态。一旦 CIP 获得批准,它将进入“Accepted”状态,并且可以开始实施。一旦实施完成,CIP 将进入“Implemented”状态。如果 CIP 未获批准,它将进入“Rejected”状态。如果 CIP 被作者撤回,它将进入“Withdrawn”状态。
Discord#
对于您想与社区讨论的尚未成熟的想法,您可以加入我们的 Discord,并在 #feature-ideas 频道与我们聊天。我们总是很高兴与社区讨论新的想法和功能。