# 来源

本规范来自 阿里巴巴-antv-x6产品;https://github.com/antvis/X6/blob/master/CONTRIBUTING.zh-CN.md

# 提交issue规范

  • 确定issue的类型
  • 避免提交重复的issue,提交前搜索现有的issue
  • 在标签,标题或内容中,体现明确的意图 随后,由项目负责人确认issue意图,更新合适的标签,关联milestone,指派开发者

# 提交代码规范

对于具有仓库开发者权限的开发者,可以创建分支,修改代码并提交Pull Request, 项目负责团队会 review代码合并到主干

Pull Request在远程仓库发起

# commit提交规范

<type>(<scope>): <subject>
    
<body>
    
<footer>
  • 提交commit的类型:
    • feat: 新功能
    • fix: 修复问题
    • docs: 修改文档
    • style: 修改代码格式,不影响代码逻辑
    • refactor: 重构代码,理论上不影响现有功能
    • perf: 提升性能
    • test: 增加修改测试用例
    • chore: 修改工具相关
    • deps: 升级依赖
  • scope: 修改文件的范围
  • subject: 一句话描述,这次提交做了什么
  • body: 补充subject,适当增加原因,目的等相关因素,可选
  • footer:
    • **非兼容修改(Breaking Change)**时必须描述清楚,
    • 关联相关 issue