diff --git "a/dev docs/\345\274\200\345\217\221\346\226\207\346\241\243.md" "b/dev docs/\345\274\200\345\217\221\346\226\207\346\241\243.md" new file mode 100644 index 0000000000000000000000000000000000000000..4f443c1b6d8eb62a312164bcc305272f117457ce --- /dev/null +++ "b/dev docs/\345\274\200\345\217\221\346\226\207\346\241\243.md" @@ -0,0 +1,148 @@ +# 开发文档 +## 1.前言 + +PHP Helper是一个**开源项目(废话)**,任何人都有编辑这个项目的权力 + +当然,我们希望您在做贡献的同时,遵守**开发文档**内的所有内容 + +遵守规则才会让仓库更整洁,不凌乱 + +本工具基于[boxxer](https://gitee.com/coco-central/boxxer "boxxer") + +使用Apache-2.0开源协议 +## 2.文件结构 + +### 2.1 结构总览 +``` +PHP Helper +├─ .git +├─ .hintrc +├─ .prettierrc +├─ LICENSE +├─ README.md +├─ css +├─ dev docs +├─ favicon.ico +├─ index.html +├─ js +├─ node_modules +├─ package-lock.json +├─ package.json +├─ patches +├─ runserver.bat +├─ version.txt +└─ static +``` +###2.2 基础文件 +- `.git,.hintrc,.prettierrc` 未知的文件 +- `LICENSE` 开源许可证 +- `README.md` README +- `css` CSS文件夹 +- `dev docs` 开发文档 +- `favicon.ico` 网页图标 +- `index.html` 主页 +- `js` JS文件夹 +- `node_modules,package-lock.json,package.json,patchs,static` Boxy文件 +- `version.txt` 版本号文件 +- `runserver.bat` 开启本地服务器 + +具体的结构会在 **正式开发** 中提到 + + + +## 3.提交规范 +### 3.1 提交标签 + +> **TIPS:提交标签可以叠加使用,如:[upd/beta/doc]更新了新文件/测试数据库功能/更新开发文档** + + - `upd` 文件更新 + - `beta` 测试功能 + - `bugfix` 修复bugs + - `feat` 新功能 + - `opt` 优化 + - `back` 回滚 + - `doc` 文档 + - `vercode` 版本号修正 + - `other`其他 + +### 3.2 格式 + + - [upd]添加了一些JS文件 + - [beta]测试数据库功能 + - [bugfix]修复了无法启动的BUG + - [feat]添加数据库功能 + - [opt]加快了访问速度 + - [back]问题无法解决,回滚到0.1.1(4513) + - [doc]更新Help文档 + - [vercode]版本号修正 + - [other]开源许可证 + + +### 3.3 使用 + + + - upd:仅增加文件,文件夹等 + - beta:测试功能 + - bugfix:修复任何bug + - feat:添加新功能,**但请先测试** + - opt:优化用户体验 + - back:出现文件/文件夹等问题,需要回退 + - doc:修改文档 + - vercode:版本号问题修复 + - other:其他 + + +## 4.版本号规范 + +### 4.1更改位置 + +请更改[Version文件](https://gitee.com/starbit/php-helper/blob/master/version.txt)以及Html内的内容 + +### 4.2基础形式 + +`a.b.c.d` + +### 4.3简介 + +`a`:主版本号 当发生大改动时修改(请不要自己改) + +`b`:子版本号 功能有一定的修改时修改 + +`c`:Commit次数 每次commit都要修改,数字是当前分支的提交数+1 + +`d`:版本标识,请见下方 + +### 4.4版本标识 + +- Release(R) 正式版 分支:master 更新速度:慢 +- Beta(B) 测试版 分支:dev 更新速度:快 +- SlowUpdate(su) 缓慢更新版 也称GithubPages版 更新速度:乌龟 + +### 4.5实例 + +`0(主版本号).1(子版本号).114(commit次数).r(标识Release)` + + +## 5.正式开发 +恭喜进入新阶段! + +### 5.1 本地部署: + + 1. clone我们的仓库:https://gitee.com/starbit/php-helper.git + 2. 打开文件夹 + 3. 运行`runserver.bat`(请先安装python并确定本地4567端口无占用) + 4. 浏览器打开:http://localhost:4567 + +**如果端口占用了,不要惊慌,用记事本打开runserver.bat** +```bash +start http://localhost:(自定义端口) +python -m http.server (自定义端口) +``` +将自定义端口那里改为没被占用的端口,万事大吉! + +~~谁会用4567当服务端口~~ + +### 5.2 开发前 + +由于**boxxer**的底层是基于**Blockly**制作的,所以建议您先阅读[Blockly中文开发文档](https://blockly.tortorse.com/) +