问题分级

本节开发指南记录了面向用户和开发者的问题跟踪器

分级检查表

  • 阅读初始消息和评论。

  • 检查标题是否足够简洁,同时包含足够的具体信息,以便扫描问题列表的人员可以快速识别其主题

  • 对于拉取请求,确保在标题之前添加相应的议题 (gh-NNNNN: 标题)。

  • 设置所有相关的 标签

  • 在适当的情况下,设置 受让人审阅人项目 字段,并可能 @ 提及相关人员。

  • 您还可以留下一个简短的评论,说明建议的后续所需操作。如果消息列表很长,摘要会非常有帮助。

  • 如果议题明显无效(与 CPython 无关、重复、垃圾邮件等),您可以使用 GitHub 的“关闭为未计划”选项。

受让人

此字段指示谁应采取下一步解决议题。

如果议题在没有他们的帮助的情况下无法继续进行,则可以将议题分配给某人;例如,他们需要就如何进行做出技术决策。另外,请查阅 专家索引,因为某些 stdlib 模块应始终分配给特定人员。

请注意,要将议题分配给某人,该人必须是团队成员,可能是分诊员或核心开发人员。

帮助分诊议题

一旦您了解 Python 源文件的结构方式并且对工作流程感到满意,那么为分诊议题提供帮助是一种很好的贡献方式。不过,请意识到,有效地帮助分诊需要有使用 Python 的经验。

全天候,新的议题在 议题跟踪器 上被打开,现有的议题正在被更新。每个议题都需要进行分诊,以确保一切顺利进行。

分类报告

对于 bug,议题需要

  • 清楚地解释 bug,以便可以重现

  • 包括所有相关的平台详细信息

  • 说明受 bug 影响的 Python 版本。

一旦您有为 Python 开发的经验,这些都是您可以提供帮助的事情

  • 尝试重现 bug:如果解释得不够清楚,您无法重现,那么核心开发人员很可能也无法重现。

  • 查看议题是否发生在不同的 Python 版本上:了解 bug 不仅会影响正在开发的 Python 版本,还会影响维护模式下的其他版本,这始终是有帮助的。

  • 编写单元测试:如果 bug 缺少应该最终进入 Python 测试套件的单元测试,那么编写该测试会非常有帮助。

所有这些都有帮助,因为它允许 分诊团队 的成员正确分类议题,以便核心开发人员及时处理。

审阅拉取请求

如果议题有一个尚未审阅的链接拉取请求,您可以通过确保拉取请求

  • 是其试图解决的问题的良好解决方案

  • 遵循风格指南 (PEP 7PEP 8风格指南 等)

  • 包括适当的测试

  • 包括适当的文档更改

  • 包括 NEWS 条目(如果需要)

  • 将作者包含在 Misc/ACKS 中,或者补丁将它们添加进去

  • main 分支没有冲突

  • 没有失败的 CI 检查

完成所有这些操作可以让核心开发人员和 分诊员 更快地查找只有具有在 Python 代码库上工作的大量经验的人才会注意到的细微问题。

另请参阅 接受拉取请求

找到您可以帮助解决的议题

如果您想帮助分诊,您可能还想搜索您有工作知识的模块中的议题。在议题跟踪器中搜索模块的名称,按标签筛选,或使用 高级搜索 来查找这些议题。