我该如何提Issue？

提Issue之前，我需要准备什么？

不论您有什么需求、遇到了什么Bug、对MindFormers套件的使用有任何疑问，请先前往MindFormers Issue列表，搜索您想提的主题，看看是否已有同样主题的Issue存在或已解决。优先浏览这些内容以查看先前用户积累的经验，这或许可以使您较快地找到解决您需求的办法，而无需等待我们的答复！

提Issue之时，我需要注意什么？

首先请您判断您的Issue属于什么类型，之后根据相应的Issue规范填写您的Issue。

如何判断我的Issue属于Question还是Bug-Report？

当你在使用套件时遇到预期外的情况，除非你非常、非常得有根据——一般情况下，除非你能够确切指出代码中不正确的地方、可以提供解决问题的源代码，或者提供回归测试来表明前一版本中的行为不正确，否则你都多半不够完全确信这是一个Bug（摘自《How To Ask Questions The Smart Way》）。无需担心，如果我们发现您提出的Question Issue中的问题确实由于Bug引起，我们将按照Bug-fix流程来进行处理。

提Issue之后，我将何时收到回复？

我们的Issue负责人每个工作日会关注所有进行中的Issue，通常我们会在注意到您的Issue时立即分配相关开发人员进行处理。请您关注Gitee通知以便及时收到我们的回复。如果您在15天内没有回复我们，我们可能会先行将您的Issue关闭，如果您还需要帮助，可以随时将Issue状态设为TODO以重新打开，我们会继续帮您解决问题。

Issue规范

在MindFormers开源仓库提Issue时请尽量遵循此规范，这可以让我们的负责人方便识别您的需求/问题并尽快让您得到回复！

类型规范

MindFormers仓库目前接受的Issue类型为

• Question：提出问题，如各种报错（启动失败、运行时错误）以及各种模型和特性的使用方法、条件等。
• Bug-Report：错误报告，适用于使用中得到未达预期的结果，如果责任人识别后发现为非代码本身问题，将按照Question流程进行处理。
• RFC：待确认的需求，适用于开发者和用户提出需求。

标题规范

Issue标题必须清晰简明，下列给出一些标题的例子：

• Question

【物理机】【MS1.10】【GLM2_6b】单机八卡微调报错：TypeError: Multiply values for specific argument: axis

【AICC】【Llama_65b】【权重上传】OBS进程数过多导致失败

• Bug-Report

【物理机】【MS2.0】【GPT2】GPT2 tokenizer的pad token id不一致

• RFC

【客户】【易用性】增加训练预估时间打印的功能

建议在标题前加上【项目】、【环境】、【模型】、【特性】等方便识别。

内容规范

Question & Bug-Report

内容必须清晰描述问题细节，需要包含至少以下内容：

• 问题描述：简单描述问题的起因经过结果，展示错误截图，尽量在附件中上传完整日志
• 所用环境：包括硬件环境（使用的机器、芯片）、软件环境（MindSpore版本、MindFormers版本）
• 重现步骤：分步骤写明重现的步骤，便于开发者重现问题
• 预期结果：预期应当出现的结果

RFC

内容必须清晰描述需求细节，需要包含至少以下内容：

• 背景信息：简单描述需求的背景，包括当前存在的问题等
• 信息来源：阐述需求来源于何组织/部门，这将有助于我们指定需求优先级
• 价值/作用：解释完成这项需求能取得的关键价值