# 贡献指南

主要是关于 pr 的指南

- [fork 本仓库](https://github.com/xushengfeng/eSearch/fork)
- clone 到本地或直接在线上编辑器修改
- 提交一个 Pull Request

## 编辑代码

首先这个项目最开始是我一拍脑袋写的，并且跨度有点大，存在大量中文变量、拼音变量、语法糖、if 嵌套等乱象，还望海涵。

- 命名规则、函数习惯等都无所谓，还望写注释
- 如果原来的代码过于抽象，可以联系我一起理解
- electron 版本一般不会太旧，我还开启了"enable-experimental-web-platform-features"，用些新语法能减轻心智负担

你可以在[开发文档](docs/develop/readme.md)查阅更多代码说明。

## 提交

commit 命名我习惯使用`范围 修复/添加某某功能`，比如`截屏 修复创建图形坐标错误`

## 合并

请耐心等待我的合并:)

## 感谢

最后提前感谢你的贡献！