审查流程
概述
本文档概述了 LangChain 维护人员用于审查拉取请求 (PR) 的流程。此流程的主要目标是增强 LangChain 开发人员体验。
审查状态
我们使用三种主要状态对 PR 进行分类，这些状态在右侧边栏中标记为项目项状态，您可以在 此处 查看详细信息。
-
初步评估:
- 所有新提交的 PR 的初始状态。
- 需要维护人员将其分类到其他状态之一。
-
需要支持:
- 需要社区反馈或更多输入才能继续推进的 PR。
- 如果获得 5 个赞，则会自动提升到待办事项列表。
- 应用此状态时会生成自动评论，解释流程和点赞要求。
- 如果 PR 保持此状态 25 天，则会通过自动评论将其标记为“过时”。
- 如果未采取进一步措施，PR 将在 30 天后自动关闭。
-
审查中:
- 我们团队正在积极审查的 PR。
- 这些 PR 会定期审查和监控。
注意：PR 每次只能拥有一个状态。
注意：您可能会注意到另外 3 种状态：已完成、已关闭和内部，这些状态位于此生命周期之外。已完成和已关闭的 PR 分别已合并或关闭。内部状态用于核心维护人员提交的 PR，这些 PR 由提交者拥有。
审查指南
-
影响 /libs/core 的 PR:
- 直接影响核心代码并可能影响最终用户的 PR。
- 初步评估指南：大多数 PR 应该直接进入
审查中或关闭。 - 这些 PR 优先级最高，审查速度最快。
- 没有简洁描述其动机（在 PR 摘要或链接的问题中）的 PR 可能会在没有深入审查的情况下被关闭。请勿使用 LLM 生成冗长的 PR 描述。
- 没有单元测试的 PR 可能会被关闭。
- 功能请求应首先作为 GitHub 问题打开，并与 LangChain 维护人员讨论。在未进行事先讨论的情况下提交的大型 PR 可能会被关闭。
-
影响 /libs/langchain 的 PR:
- 与核心 PR 密切相关但优先级略低的重大影响 PR。
- 初步评估指南：大多数 PR 应该直接进入
审查中或关闭。 - 这些 PR 会积极审查和关闭，类似于核心 PR。
- 新的功能请求应事先在问题中与核心维护团队讨论。
-
**影响 /libs/partners/**** 的 PR
- 涉及集成包的 PR。
- 初步评估指南：大多数 PR 应该直接进入
审查中或关闭。 - 根据 PR 的内容，审查可能由我们的团队进行或移交给合作伙伴的开发团队。
- 我们与大多数合作伙伴开发团队保持沟通渠道，以促进此流程。
-
社区 PR:
- 大多数社区 PR 的初始状态将为“需要支持”。
- 初步评估指南：大多数 PR 应进入
需要支持。高流量集成的错误修复应直接进入审查中。 - 初步评估指南：所有新的功能和集成都应进入
需要支持，如果未获得足够的支持（通过点赞或评论衡量），则将被关闭。 - 处于
需要支持状态 20 天的 PR 将被标记为“过时”，如果未采取任何措施，则将在 30 天后关闭。
-
文档 PR:
- 影响 docs/docs 中文档内容的 PR。
- 初步评估指南:
- 修复单个文件中的错别字或小错误并通过 CI 的 PR 应直接进入
审查中。 - 在问题中已讨论并达成一致意见的更改的 PR 应直接进入
审查中。 - 添加新页面或更改文档结构的 PR 应进入
需要支持。
- 修复单个文件中的错别字或小错误并通过 CI 的 PR 应直接进入
- 我们努力标准化文档格式，以简化审查流程。
- CI 作业针对文档运行，以确保符合标准，从而自动化大部分审查工作。
-
PR 必须使用英文:
- 非英文的 PR 将在未经审查的情况下关闭。
- 这是为了确保所有维护人员都能有效地审查 PR。
如何查看 PR 的状态
参见屏幕截图
要查看所有打开的 PR 的状态，请访问 LangChain 项目看板。
审查优先级
我们的目标是通过专注于制作以下软件来提供最佳的开发体验
- 工作：按预期工作（无错误）。
- 有用：通过开箱即用的组件和简化应用程序构建的运行时来改进 LLM 应用程序开发。
- 简单：使用直观且文档齐全。
我们相信此流程反映了我们的优先级，如果您认为它没有反映，我们乐于接受反馈。
GitHub 讨论
我们欢迎您对此流程提供反馈。请随时在 此 GitHub 讨论 中添加评论。