Commit e6c90fcc authored by Junling Bu's avatar Junling Bu
Browse files

update[doc]: 更新日志文档和贡献指南。

parent 2f44889c
## 更新日志
### V 0.4.0
*2018-04-21*,项目结构调整,增加了两个模块
* `小商场`的后台服务代码添加注释,校验输入参数
* `小商场`商品无货时显示“商品已售空”
* `管理后台`支持管理员同一账户多终端登录,方便演示
* `管理后台`专题内容支持富文本编辑
* `基础系统`litemall-os-api的链接从`storage/index/index`调整至`os/index/index`
* `基础系统`litemall-os-api支持浏览器显示。
* `基础系统`新增litemall-core模块,综合了litemall-os-api、litemall-wx-api
和litemall-admin-api的共性代码
* `基础系统`新增litemall-all模块作为包裹模块,支持三个后台服务和静态文件
打包成一个war项目包
### V 0.3.0
*2018-04-07*,业务模块从物理删除调整成逻辑删除
* `小商场`的后台服务加密用户账号密码
* `小商场`如果用户选择货品,则显示货品对应的价格;否则显示商品价格
* `小商场`只有规格都选择,则商品页面才显示所对应货品的规格文本
* `管理后台`商品详细信息支持tinymce富文本编辑
* `管理后台`的后台服务加密管理员密码
* `管理后台`完善登录退出逻辑
* `基础系统`数据库中除regions几个表,其他所有表都添加`add_time``deleted`字段
* `基础系统`litemall-db模块不支持数据物理删除,删除则设置`deleted`,而查询则过滤`deleted`
### V 0.2.0
*2018-04-02*,修复一些小商场出现的问题。
* `小商场`微信登录
* `小商场`账号登录、注册、找回密码
(注意手机验证码不支持,因此目前只是完成基本功能,但是存在安全风险)
* `小商场`订单编号采用日期+6位随机数
* `小商场`简单运费计算
* `小商场`专题评价
* `管理后台`禁止管理员修改超级管理员信息
* `基础系统`自动脚本util/lazy.sh和util/upload.sh
### V 0.1.0
*2018-03-24*, 项目架构基本完成。
\ No newline at end of file
## 贡献
任何形式的贡献都欢迎,包括:
* Issue里面报告的BUG
* Issue里面对业务或技术的讨论
* Pull Request
* 对文档的意见或补充
* 其他任何有意义本项目的行为
个人能力有限,欢迎一起开发。
目前项目基本框架已经建立,但是还不完整,因此非常欢迎人一起讨论技术和业务。
但是交流合作之前,请查看以下碎碎念。
### 项目理念
litemall的设计受众是小微型企业,而不是互联网企业,因此litemall的开发理念是一个小而美:
* 小,指的是技术简单、架构简单、性能指标低、业务仅覆盖基本功能
* 美,指的是技术新、架构清晰易扩展、安全系数不低、业务可直接部署使用
正是因为以上考虑,目前litemall的架构是简单的,三种技术栈都是最基本的。
虽然这么说,但是实际上开发的入门门槛不低:
* 项目采用了三种技术栈,相互之间是相对独立的;
* 采用的spring boot框架和vue-element-admin框架已经依赖相当多的库;
* 除了开发技术,开发过程中也会涉及其他技术,包括环境配置、版本控制、
测试技术、日志、部署等等。
因此贡献新的代码或讨论业务前,建议考虑以下问题:
* 是否引入过多的复杂性,而没有带来相应的收益?
因为本项目希望能够为更多的人所学习使用,项目的复杂性是需要考虑的问题。
如果是复杂性和收益是相同的,那么接收贡献的可能性其实值得讨论。
* 是否依赖过多的库?是否必须依赖该库?如果仅仅是该库的微小部分,是否可以自己实现一个简单的util类?
例如,一些技术框架采用了fastjson,而实际上spring boot已经默认采用jackson,因此如果没有特殊原因,
贡献者应该尽可能采用jackson。
* 是否盲目地采用过多过先进的技术?是否可以暂缓采用?
这里是谨慎的。例如,如果要引入缓存技术,则需要去学习缓存相关的类库,以及可能会遇到一些使用中存在的问题。
而v2.0.0之前其实没有必要提前考虑性能问题。同样地,单点登录技术是分布式架构中必须存在的基本功能,但是
目前两个后台服务分别采用各自登录方案即可。
注意:
> 这里并不是拒绝新技术,而是希望采取一个渐进式的谨慎的态度。
> 此外,对于新技术运用,其实规划是基于本项目稳定版本再开发一个独立的分布式版本。
* 已经有了一个技术,是否有必要贡献相同目的的另外一种技术?
这里是欢迎的。例如,已经有了vue框架的管理后台,但是采用其他前端框架的管理后台也是欢迎的。
这样可以给不同技术背景的用户所选择。当然,应该尽量保持不同版本之间的同步。又或者,小程序
已经有了一些开发框架,而目前小商场的小程序端仍然是原始的小程序技术,因此基于这些新的开发框架
来重构小程序端是欢迎的。
也就是说本项目希望避免技术深度,而倾向于技术宽度,帮助自己以及更多的人学习了解不同的技术。
* 贡献代码量不大,或者改善文档。
这里是欢迎的。很多开源项目都建议贡献代码时应该少量并且逻辑分明。这样审阅代码时才能明确。
当然,如果是单词拼写不对之类,那么应该尽可能在一次commit中修复同样的问题。
虽然这里可能表现出对新技术的谨慎态度,但是如果用户发现有更好的技术或者有必要,欢迎讨论。
当然,如果开发者不认同这里的一些理念,也可以基于自己的技术选型来开发自己的版本。
如果认为自己开发的好,可以在本项目提交链接地址,让其他开发者了解。
### 项目业务
本项目所设想的基本业务功能已经在文档中列举完成。
如果希望引入高级功能,例如分销功能等,建议用户在本项目基础上自行开发。
如果认为有基本业务没有实现,可以Issue或者QQ群讨论,加入后续开发计划。
当然更希望开发者直接提供代码,丰富完善目前的基础业务功能。
### 代码贡献
* 代码规范目前没有严格要求,后续会补充。
### Issue规范
* 在提交issue之前,请搜索是否存在相关问题。
* 提交的Issue请尽可能给出详细信息
* 建议Issue基于最新的代码
### QQ群提问
不建议开发者在QQ群讨论遇到的Bug或者问题,而是应该在Issue中提交。
当然,如果仍然坚持,那么请先看看[提问的智慧](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/master/README-zh_CN.md)
\ No newline at end of file
......@@ -107,6 +107,8 @@ litemall
5. [商场子系统](doc/5.md)
6. [下一步计划](doc/6.md)
文档内容采用 [署名-禁止演绎 4.0 国际协议许可](https://creativecommons.org/licenses/by-nd/4.0/deed.zh)
开发计划
====
......@@ -126,7 +128,7 @@ V 3.0.0 完成以下目标:
1. 管理后台一些辅助功能
2. 后台服务加强安全功能、配置功能
3. 项目代码重构和清理
4. 其他配套服务,如代码文档、war部署支持
4. 其他配套服务,如代码文档
项目结束,已经是一个真正可工作的项目,此时进入维护阶段。
......@@ -139,39 +141,12 @@ V 3.0.0 完成以下目标:
> ** 以上仅仅是个人规划的开发计划,实际可能出现任何情况,例如能力有限而放弃开发。**
开发进度更新
==
======
查看[更新日志](CHANGELOG.md)
目前V0.4.0
* V 0.1.0,项目架构基本完成。
* V 0.2.0,修复一些小商场出现的问题。
* `小商场`微信登录
* `小商场`账号登录、注册、找回密码
(注意手机验证码不支持,因此目前只是完成基本功能,但是存在安全风险)
* `小商场`订单编号采用日期+6位随机数
* `小商场`简单运费计算
* `小商场`专题评价
* `管理后台`禁止管理员修改超级管理员信息
* `基础系统`自动脚本util/lazy.sh和util/upload.sh
* V 0.3.0,
* `小商场`的后台服务加密用户账号密码
* `小商场`如果用户选择货品,则显示货品对应的价格;否则显示商品价格
* `小商场`只有规格都选择,则商品页面才显示所对应货品的规格文本
* `管理后台`商品详细信息支持tinymce富文本编辑
* `管理后台`的后台服务加密管理员密码
* `管理后台`完善登录退出逻辑
* `基础系统`数据库中除regions几个表,其他所有表都添加`add_time``deleted`字段
* `基础系统`litemall-db模块不支持数据物理删除,删除则设置`deleted`,而查询则过滤`deleted`
* V 0.4.0, 项目结构调整,增加了两个模块
* `小商场`的后台服务代码添加注释,校验输入参数
* `小商场`商品无货时显示“商品已售空”
* `管理后台`支持管理员同一账户多终端登录,方便演示
* `管理后台`专题内容支持富文本编辑
* `基础系统`litemall-os-api的链接从`storage/index/index`调整至`os/index/index`
* `基础系统`litemall-os-api支持浏览器显示。
* `基础系统`新增litemall-core模块,综合了litemall-os-api、litemall-wx-api
和litemall-admin-api的共性代码
* `基础系统`新增litemall-all模块作为包裹模块,支持三个后台服务和静态文件
打包成一个war项目包
警告
==
......@@ -180,7 +155,6 @@ V 3.0.0 完成以下目标:
> 3. 项目代码目前还不完善,仍处在开发中
> 4. 项目开源(MIT),但不承担任何使用后果
致谢
==
......@@ -201,26 +175,16 @@ V 3.0.0 完成以下目标:
开发者有问题或者好的建议可以用Issues反馈交流,请给出详细信息,本人会尽可能解决。
* 如果问题是共性问题(如代码bug或文档不全),本人会及时解决。
* 如果问题是个人问题(如开发者了解不深入或者没有相关技术),请见谅(本人也是百度和谷歌)。
* 请教问题,
贡献
==
任何形式的贡献都欢迎,包括:
* Issue里面报告的BUG
* Issue里面对业务或技术的讨论
* Pull Request
* 对文档的意见或补充
* 其他任何有意义本项目的行为
个人能力有限,欢迎一起开发。
目前litemall开发交流群:
任何形式的贡献都欢迎,查看[贡献指南](CONTRIBUTE.md)
![](doc/pic/qq.png)
注意:
> * 这是开发交流群。
> * 如果开发者开发使用中有问题,建议采用Issue来报告问题和解决问题。
> * 在开发交流群中应讨论开发、业务和合作问题。
> * 交流结果如果是共识性的则在文档中记录,如果是开放性的则会在Issue中记录。
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment