问题
概述
创建和更新 RAPIDS 项目问题的最佳实践概述。
目标受众
社区
开发者
另请参阅
创建问题
重要提示:在创建问题之前,请搜索现有已打开和已关闭的问题以及拉取请求,查看您的问题是否已被解决。
按照此处的步骤开始创建问题的流程。
RAPIDS 项目中的问题分为四种类型。创建问题时,请从这些选项中选择最适合的一种
问题类型 | 标题前缀 | 描述 |
---|---|---|
错误 | [BUG] |
报告代码问题 |
文档 | [DOC] |
报告与文档相关的问题或建议 |
功能 | [FEA] |
建议新想法或改进 |
疑问 | [QST] |
向 RAPIDS 团队询问项目相关问题 |
如果您的 issue 确实不属于上述任何一种,您可以选择Open a regular issue
。请谨慎使用此选项。
如果适用,考虑为问题添加good first issue或help wanted标签。
格式
标题
使用上面列出的相应类型前缀。创建问题时应自动填充此内容。
标题应简洁描述问题、功能或疑问。如果与代码相关,尝试在标题中包含类名或函数名。
描述
使用四种问题类型之一时,描述将填充模板,指导您如何描述问题。
一般来说,您需要充分描述问题,以便他人能够完全理解和重现问题。
任务列表
每个Bug
、Documentation
和Feature
问题都应该有一个任务列表,即使只有一个条目。
如果您不确定任务分解,请添加评论说明需要帮助来确定任务。
当开发者处理问题时,或许在创建了一个[WIP]
拉取请求后,他们应该更新任务列表并标记已完成的任务。
阻塞项
如果问题因另一个问题或拉取请求而受阻,请执行以下操作
- 添加0 - Blocked标签
- 在任务列表顶部为每个阻塞问题添加一个任务,内容为:
Waiting on issue ###
生命周期
问题由团队负责人分配或按优先级顺序选取。如果您不确定要处理什么,请遵循此指南。
当您开始处理问题时,更新标签以移除1 - On Deck或0 - Backlog,并添加2 - In Progress。
当相关的拉取请求合并后,问题将自动关闭。