Issue 规范

    Issue 说明

    Issue 一般分为以下几类

    1. BUG 修复
    2. 新提需求
    3. 优化建议
    4. 答疑交流

    提 issue 前可参考的文章

    记录一些常见的沟通问题

    提问的智慧

    Issue 建议

    1. BUG 修复

    标题格式:[BUG]: 问题简介

    内容需包含:

    
    
    1、BUG 描述
    
    问题的描述,请尽量使用简短、准确的语言
    
    2、复现步骤
    
    具体的复现流程, 能复现的BUG才能更快的解决
    
    3、期望行为
    
    4、运行环境
    运行环境: 开发环境 / 预生产环境 / 生产环境A / 生产环境B
    运行设备: 物理机/虚拟机/华为mate30/iphone
    运行系统: RedHat 6.8 / Ubuntu 20.04 / 安卓 12 / IOS 13
    软件版本: JDK 8 / JDK 17 / Python3.8 / Node 14
    5、附加信息
    
    包括视频、图片等补充信息
    

    2. 新提需求

    标题格式:[需求]: 问题简介

    内容需包含:

    ## 背景
    
    - 描述你希望解决的问题的现状
    - 附上相关的 issue 地址
    
    ## 思路
    
    描述大概的解决思路,可以包含 API 设计和伪代码等
    
    ## 跟进
    
    后续编辑,附上对应的 Pull Request 地址,可以用 `- [ ] some task` 的方式。
    

    3. 优化建议

    标题格式:[优化]: 问题简介

    内容需包含:

    1、优化描述
    
    2、关联 Issue
    
    3、具体优化建议
    
    4、运行环境(非必填)
    
    5、附加信息
    
    
    

    4. 答疑交流

    标题格式:[答疑]: 问题简介

    此处可列出该工程所属答疑的 支撑群二维码 或者 论坛地址

    评论栏