先描述观察到的行为
写出做了什么、期望发生什么、实际发生什么。把判断和观察分开，例如先说明返回了哪个错误，再解释为什么认为它与某次修改有关。
提供最小输入与环境
保留能触发问题的最少步骤，记录软件版本和运行环境。分享前移除密码、令牌和个人数据，尽量使用可以公开的替代样本。
说明已经排查的范围
列出实际尝试过的步骤及结果，避免简单写“都试过了”。如果发现临时绕过方式，也说明它的条件和限制，帮助维护者进一步定位。
让问题报告更容易被复现
一个小而完整的复现过程，可以节省来回沟通的时间。
继续读
把 Git 提交拆成可以解释的变化
一次提交最好能够用一句具体的话说明它改变了什么。
收到 JSON 文件后，先检查这几件事
格式合法、结构符合预期、字段含义正确，是三个不同的问题。