Merge branch 'dev' into feature/followship

README.md

@@ -57,7 +57,7 @@ PaoPao主要由以下优秀的开源项目/工具构建
 
 ### 环境要求
 
-* Go (1.17+)
+* Go (1.18+)
 * Node.js (14+)
 * MySQL (5.7+)
 * Redis
@@ -464,17 +464,43 @@ MinIO: # MinIO 存储配置
 ...
 ```
 
+### 源代码分支管理 
+**主代码库`github.com/rocboss/paopao-ce`**      
+```bash
+git branch
+main
+beta
+dev
+feature/bleve
+feature/followship
+feature/mir
+feature/localoss
+jc/alimy
+```
+**分支说明**        
+* 分支`main`是主分支，也是paopao-ce的稳定版本发布分支，只有经过内部测试，没有重大bug出现的稳定代码才会推进到这个分支；该分支主要由`beta`分支代码演进而来，原则上**只接受bug修复PR**。`rc版本/稳定版本` 发布都应该在`main`主分支中进行。
+* 分支`beta`是公测分支，代码推进到`main`主分支的候选分支；该分支主要由`dev`分支代码演进而来，**接受bug修复以及新功能优化的PR**，原则上不接受新功能PR。`alpha/beta版本` 发布都应该在`beta`公测分支下进行。
+* 分支`dev`是开发分支，**不定期频繁更新**，接受 *新功能PR、代码优化PR、bug修复PR*；**新功能PR** 都应该首先提交给`dev`分支进行合并，bug修复/代码优化 后 **冻结新功能** 将代码演进合并到`beta`分支。
+* `feature/*`是新功能子分支，一般新功能子分支都是 *从`dev`开发分支fork出来的*；子功能分支 **只专注于该新功能** 代码的开发/优化，待开发接近内测阶段 *提交新功能PR给`dev`分支进行review/merge*，待新功能代码演进到`beta`分支后，原则上是可以删除该分支，但也可以保留到稳定版本发布。**该分支专注于新功能的开发，只接受新功能的bug修复/优化PR**。
+* `jc/*`是代码库维护者的开发分支，一般包含一些局部优化或者bug修复代码，有时可以直接将代码merge到`dev/beta`分支，原则上不允许直接merge代码到`main`主分支。
+
+**代码分支演进图**        
+![](docs/proposal/.assets/00-01.png)
+
 ### 其他说明
 
 建议后端服务使用 `supervisor` 守护进程，并通过 `nginx` 反向代理后，提供API给前端服务调用。
 
 短信通道使用的[聚合数据](https://www.juhe.cn/)，如果申请不下来，可以考虑替换其他服务商。
 
-代码结构比较简单，很方便扩展。 开发文档请参阅[docs](docs '开发文档').
+代码结构比较简单，很方便扩展，开发文档请参阅[docs](docs '开发文档').
 
 ## 👯‍♀️ 贡献
+paopao-ce 是一个利用 *业余时间* 本着 **"Just for fun just do it."** 的心态 *持续有序* **开发/优化/维护**的开源项目，没有KPI考核、没有Roadmap进度压力，或许有些许不足之处，但是重在精神可嘉。 借用网络中的话 **"F\*k talk, f\*k of tech innovation, Shut up and give me your code."** 一切都因更好的体验，一切都是为了爱好，一切都在代码里；期待老铁们加入，一起开发、一起折腾、一起快乐。
+
+喜欢的朋友记得给个Star，欢迎贡献PR。  
 
-喜欢的朋友欢迎给个Star、贡献PR。
+[![Star History Chart](https://api.star-history.com/svg?repos=rocboss/paopao-ce&type=Date)](https://star-history.com/#rocboss/paopao-ce&Date)
 
 ## License
 

docs/proposal/.assets/06-01.drawio

@@ -0,0 +1 @@
+<mxfile host="Electron" modified="2022-11-23T10:14:45.410Z" agent="5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/20.3.0 Chrome/104.0.5112.114 Electron/20.1.3 Safari/537.36" etag="jm0W3UUjLzdKpiLbAjiR" version="20.3.0" type="device"><diagram id="ZOxuEieQiebRqiN2HW-F" name="Page-1">7V1de6I4GP01XE4fkhA+LrV1di46z3an8+zuXO2DEJUdKi7gtJ1fv0EIQoI1Uj7iaG8qUVHec0jynvckauj26eW32N2sPkc+CTWo+y8autMgBBhD+i9rec1bHGTkDcs48IsX7Rseg5+kaNSL1m3gk6T2wjSKwjTY1Bu9aL0mXlprc+M4eq6/bBGF9U/duEsiNDx6bii2/hX46SpvtaG1b/9EguWKfTIwnfyZJ5e9uLiSZOX60XOlCc00dBtHUZo/enq5JWEWPBaX/H0fDzxbfrGYrFOZN3y6/4b++fjzT2/6w8Tb1dTx/l19gFZxIT/ccFtccvF101cWgzjarn2SnUbX0PR5FaTkceN62bPPFHXatkqfQnoE6MMkjaPv5DYKo5i2rKM1KRtZALOXLaJ1WqANjOKYvUmDSN/9Ze1BGHInW8auH5D9y4vm4jpInJKXgyECZeApY0n0RNL4lb6keINVQPXKwCyOn/fIW3rRtqqgXja6BduW5an3gNAHBSYn4WML+HwO4vdBtIt98V5Ej7OYBZTykzBYrmlbGm04hGwRIccpEOog7gDatcAjJAYeWkAMPMD9Bd45fmMcibObbPIuaRG8ZNh0EirDqYcKIiFUADdFqq9A2bqSgUImUi1QQAjUI4l/uOs06e5+5vpWqL/Rt3ZBR7NOR0NvuHObu8zewgyV5CPUuRvXwSIfGwIF+gsUUjJQSDdUC5RxPFBk7U+y6SY98kI3SQKvHqn6DU1DEb/+nR3cYHb4rfrc3Uvt6JUdvQTp35XH3/anoEf7N2UH7D35VyW+MM/lAKGXE21jj7wVCaeIROrGS5IeHz5FkCsg4gYQWVtMQjcNftS/chOyxSc8RAG9mP3Nxo2S0OTIkV9q8a7qpJk7ET/cCifKIyGcaEe08rLfwz3cOfcYh0refKvSppFDJV9Bja178h7ga5fcY/OM49zLWToW9xCqUwbzyYEs96A9NvfMYbgH5Lh3Yl/ZJfdYMnCce/ns4+y5hzjuGXyi1Tv3JHSJAfs9jntgyH4PSXNP167c64J7ouYyDdZ+sF4KFKTT3FRC/2pQsdxCbPEoI0jcoMI8Bb6ffUxj9len9hsJ4E5c07pI9LhZOSyOK+QyG8iF+puViwLNF9oj0FheLEhI5zWPsUFyRHHowY3dJ1HxUA8kqwNEgMNl/aaYzA6MiKhCfSHJNkwvBBFoKoeIKFh9If9tSSIDiXyoY5IEP9357lRZYDfZ+Lm7GDzV8F12rm0aJUWPdALadYTqHRvuqkDApUIsGayAZg8Lmiie0dtoE60TckWNDUfAOIoaaBKHe4RNRsoLw2CTHOqd3lI/e4ghxMYNrkfREqMIG4II+wviaZpUQbiDiRkftTaJWr3ADLOWlbvJThkG6++9qKDK5FlttU1ocsTiE7a+8yxH1Jc+ff36IHKJonbvzknYXyda5aCpiSXyk4vfhR+l+FCtvBurhHvr7jrYIeg3wORKSR9gJ8T6UE8e+HpKtFgkpCciiGLP8svDrUCE83Y5GHzpXgGXgyNKHULUR6gBGpwTZ/zivSOqDSoEyrR5WWbkQCFdzPgzlwOJz9fkYDh1No5vckC6mMWrQEeMuPt27No90sXkWoVAmRCrFigJN8hFmBwQkC645KPnWIkA5gbJ1iYHfrQdutBcOn4UKfaNaHJg04yj3CtYOhb3TLNOmdbFPhOMzb2BDDbqmxxYLnCce/qBwe3MuGdx3Bu60Iz0gQw2ypscymmaxJg7qrHwF+KeqLncES/yZcoXY9cBeyqfGzY3KR+7fI50UZ6ZrS8bJBPyisfoIInS0EV5HDCsd2WjV9QR61sv1eOAHeUQaXKdXD0OtdEHc5nQ2B4HBETt7Opx4IcjhI+iNqzHodSvzsbjgC2smsehtK5cqMdBNXmprbSJ2RqWkTwOCIjy0tXjUNxdl+RxQEDUes5/9bdV77YNXaw+D1wYBaKscf7lZ1O5KKtpG1FujT0CatpGlFtjj6CYsqsQKPUMDVDMpFUIlHqGBhaXtwLFJtBeHCXJ3I2PjwP7QSM78t1kVR7Us1KfLNxMcZIfKuS3uhIzgQ4QtLi+E4ujjNmkP/SXg0GJRPaK4EEEMasejIigRBZ9RfAggqBBTBoaQRl7RCkmMSz9aEuTwllrkekQjGLQuwe2AxgNUB8MSwP3aHIWPM1pcEzOao9DG3NfxaAALVM7yZy1O3ogcUADmQkonTsX2A1y3DUDx102xNWEMC9Ayy8b4uoUQ0tq8LStQfrnMmjHZQtfqdyKygaXlIHWVLbwDU3R93/cetXBmS0hq/wy06XkO0m9FbsJ2ebIHWlm3ETKNMafSEkoQe/YaPnQHOkUrbKK5v58/U2TxLXNGIlmHgTMm4YVTHZvSCEJKerSkDIFpAwVkBK1sDs3deduZlD4+JhGcba7O/x463or+l+/j5aB985CQCswm5aWtgOzXofoAFlLQBargKyEeDcAbKZC9yBA9TKQ6YhjGm5ydYH+NFYkKnSPf9wfnrO8hkG2Qxc6jtc8B/d+Xja43vflDvLftyk9DWHAVlwVrWQDaZB7lw3K+WaBsKXLWVt7vA1F/a7oS68It0EYqYewqO/9Pn284tsSXwerhm+T7YTewho0d4GdxzWgzf+2EUsAP+TATOgLgLl52UWIPU8fLbP/s/UyA/JKl1Z0MWz7RjnCiOraze7vvEDuSLaoe+TejzhmPwKiDt4SmtMwamrLZYhtrLRah6opS1WOq6Zo1GWzpcWG5Xk8p6T3Z+a2CxAqCX3LpEhCShuasrAlZ+GVtJdBWkNCVRyatFZL0lpX0l4IaSXMhmcyORirowWynM0XCFw5+27OSkjHZ8LZsfpZec5aV852wtnTNl8bwJ41UjIFD2x+OxKh+MqJ9I5qnBtecKj0TihRuJ+tmV5wHuu2ZcS6jtUZ5MAbbkkb0MfeOsFocODOTM2eaROszbBm4+LBFGi22G38MgB3Ue3m1DfAfgyl9gPfg4Lb4MudGdrU1pzJDtyJNgHazNHo0DadajNbm840+q0vAW56FVEc/KRtLruWMFsh/UC/QhpEjdd0z72gvLYuyMPt2MV+gGq8nR6MBics7RocSg5910fcaZPZhbKnc7wxGB/vBq2+AW86INxpjr3rP6A2sa8wnwCzicUxwRkWZQl5Oy+VNbiX/CAmXtH50dlq1l7FeVOxj2e1tzmNfcVS3oBmlNflbvO9HrRqgvGmb1ja8jbAahyLn9WVy06PrE7tcQk9S1mqmyvNHr8utqFKtysFzfRsMl9woNF23yX2wuNAN/qYlRvCrLwJv2H3xsKiMtr4kyXjYmfDOTLNBuwwsX1jAOwMiI4C11E6RQ/jKDOn7BPp2N2sPkd+tqnO7H8=</diagram></mxfile>

docs/proposal/006-关于paopao-ce的结构设计.md

@@ -0,0 +1,17 @@
+| 编号 | 作者 | 发表时间 | 变更时间 | 版本 | 状态 |
+| ----- | ----- | ----- | ----- | ----- | ----- |
+| 006| 北野 | 2022-11-23 | 2022-11-23 | v0.0 | 提议 |
+
+### 关于paopao-ce的结构设计
+![](.assets/06-01.png)
+
+### 疑问
+
+1. 为什么要引入[go-mir](https://github.com/alimy/mir)?    
+TODO;   
+1. 为什么要兼容RESTful服务与gRPC服务？      
+TODO；   
+
+### 更新记录
+#### v0.0(2022-11-23) - 北野
+* 初始文档， 先占个位置

docs/proposal/README.md

@@ -1,4 +1,5 @@
 ## Draft
 * [001-关于paopao-ce的设计定位](001-关于paopao-ce的设计定位.md "关于paopao-ce的设计定位")
 * [002-关于Friendship功能项的设计](002-关于Friendship功能项的设计.md "关于Friendship功能项的设计")
-* [003-关于Followship功能项的设计](003-关于Followship功能项的设计.md "关于Followship功能项的设计")
+* [003-关于Followship功能项的设计](003-关于Followship功能项的设计.md "关于Followship功能项的设计")
+* [006-关于paopao-ce的结构设计](006-关于paopao-ce的结构设计.md "关于paopao-ce的结构设计")