# 前端贡献指南

创建一个新算法的流程

  1. Fork前端仓库 (opens new window),在Fork后的仓库上进行修改

  2. 修改文件如下:

    • 如果添加一个排序算法(或某些数组算法),仅需修改

      src/components/generator/sort.js

    • 如果添加一个树算法,仅需修改

      src/components/generator/tree.js

    • 如果添加一个图算法,仅需修改

      src/components/generator/graph.js

  3. 修改方式

    请按照文件中的注释进行,同时也提供了示例,请参照示例编写

    函数的参数解释如下:

    参数 解释 其他
    data 一个数组,存储样例数据(对于树,索引为结点在完全二叉树中的位置,空结点为undefined)
    mvs 一个Vueref对象,存储动作数据(关于可用的动作数据,查阅AlgoMotion文档 (opens new window) 赋值或push时,使用mvs.value
    infos 一个Vueref对象,存储信息数据 赋值或push时,使用infos.value
    rel(仅Graph) 一个二位矩阵,表示图的边
    start(仅Graph) 对于某些算法的起始结点index
  4. Debug

    npm install
    npm run dev
    
  5. commit&push

    commit的信息格式为feat:sort-bubble(修改了sort.js,且新增了名为bubble的函数)

  6. 向前端仓库提交Pull Request,等待Merge