docs: 完善 README 文档项目结构、贡献代码、鸣谢部分内容
This commit is contained in:
Charles7c
parent
107c10c698
commit
64dda84387
69
README.md
69
README.md
@ -23,7 +23,7 @@
|
||||
|
||||
## 简介
|
||||
|
||||
ContiNew Admin 中后台管理框架/脚手架，Continue New Admin，持续以最新流行技术栈构建，拥抱变化，迭代优化。当前采用的技术栈：Vue3、TypeScript、Arco Design Vue、Spring Boot、Undertow、Sa-Token、JWT、MariaDB、MyBatis Plus、Redis、Redisson、Easy Excel、Hutool 等。
|
||||
ContiNew Admin （Continue New Admin）中后台管理框架/脚手架，持续以最新流行技术栈构建，拥抱变化，迭代优化。在社区贡献者的支持和参与下，持续发展并源源不断地为企业级项目开发提供助力。当前采用的技术栈：Vue3、TypeScript、Arco Design Vue、Spring Boot、Undertow、Sa-Token、JWT、MariaDB、MyBatis Plus、Redis、Redisson、Easy Excel、Hutool 等。
|
||||
|
||||
## 项目源码
|
||||
|
||||
@ -144,20 +144,22 @@ continew-admin # 全局通用项目配置及依赖版本管理
|
||||
│ │ └─ charles7c
|
||||
│ │ └─ cnadmin
|
||||
│ │ └─ tool
|
||||
│ │ ├─ mapper # 系统工具相关 Mapper
|
||||
│ │ ├─ model # 系统工具相关模型
|
||||
│ │ │ ├─ entity # 系统工具相关实体对象
|
||||
│ │ │ ├─ query # 系统工具相关查询条件
|
||||
│ │ │ ├─ request # 系统工具相关请求对象
|
||||
│ │ │ └─ vo # 系统工具相关 VO（View Object）
|
||||
│ │ └─ service # 系统工具相关业务接口及实现类
|
||||
│ │ └─ impl # 系统工具相关业务实现类
|
||||
│ │ ├─ config # 系统工具相关配置
|
||||
│ │ │ └─ properties # 系统工具相关配置属性
|
||||
│ │ ├─ enums # 系统工具相关枚举
|
||||
│ │ ├─ mapper # 系统工具相关 Mapper
|
||||
│ │ ├─ model # 系统工具相关模型
|
||||
│ │ │ ├─ entity # 系统工具相关实体对象
|
||||
│ │ │ ├─ query # 系统工具相关查询条件
|
||||
│ │ │ ├─ request # 系统工具相关请求对象
|
||||
│ │ │ └─ vo # 系统工具相关 VO（View Object）
|
||||
│ │ ├─ service # 系统工具相关业务接口及实现类
|
||||
│ │ │ └─ impl # 系统工具相关业务实现类
|
||||
│ │ └─ util # 系统工具相关工具类
|
||||
│ └─ resources # 工程配置目录
|
||||
│ ├─ mapper # MyBatis Mapper XML 文件目录
|
||||
│ └─ templates # 模板文件
|
||||
│ └─ generator # 代码生成器模板
|
||||
│ ├─ admin-backend # 管理系统后端模板
|
||||
│ └─ admin-frontend # 管理系统前端模板
|
||||
├─ continew-admin-common # 公共模块（存放公共工具类，公共配置等）
|
||||
│ └─ src
|
||||
│ └─ main
|
||||
@ -381,22 +383,57 @@ pnpm dev
|
||||
|
||||
## 反馈交流
|
||||
|
||||
💬 非常欢迎各位小伙伴儿在 Issues、Discussions 中进行交流探讨~
|
||||
💬 非常欢迎各位小伙伴儿在 [Issues](https://github.com/Charles7c/continew-admin/issues)、[Discussions](https://github.com/Charles7c/continew-admin/discussions) 中进行交流探讨~
|
||||
|
||||
💬 也欢迎各位小伙伴儿扫码加作者好友（请备注：cnadmin），作者拉你进群，随意聊聊技术、提提需求，吐吐槽~
|
||||
💬 也欢迎各位小伙伴儿扫码加作者好友（请备注：cnadmin 已点亮 star），作者拉你进群，随意聊聊技术、提提需求，吐吐槽~
|
||||
|
||||
<div align="left">
|
||||
<img src="https://s1.ax1x.com/2023/03/09/ppnhe0A.jpg" alt="二维码" width="200" />
|
||||
</div>
|
||||
## 贡献代码
|
||||
|
||||
## 特别鸣谢
|
||||
ContiNew Admin 致力于持续以最新流行技术栈构建，拥抱变化，迭代优化。作为一个开源项目，Creator 的初心是希望 ContiNew Admin 在社区贡献者的支持和参与下，持续发展并源源不断地为企业级项目开发提供助力。我们非常欢迎广大社区用户为 ContiNew Admin 贡献或优化代码。
|
||||
|
||||
如果您想进行贡献或优化代码，可以按照以下步骤操作：
|
||||
|
||||
1. 首先，在 Gitee 或 Github 上将项目 fork 到您自己的仓库
|
||||
2. 然后，将 fork 过来的项目（即您的项目）克隆到本地
|
||||
3. 修改代码时，请务必在 dev 分支上进行修改
|
||||
4. 修改完成后，将代码 commit 并 push 到您的远程仓库的 dev 分支
|
||||
5. 在 Gitee 或 Github 上新建 pull request（pr），选择好源和目标，按模板要求填写说明信息后提交即可（多多参考 [已批准合并的 pr 记录](https://github.com/Charles7c/continew-admin/pulls?q=is%3Apr+is%3Amerged)，会大大增加批准合并率）
|
||||
6. 最后，耐心等待维护者合并您的请求即可
|
||||
|
||||
请记住，如果您有任何疑问或需要帮助，我们将随时提供支持。
|
||||
|
||||
> 欢迎大家为 ContiNew Admin 贡献代码，我们非常感谢您的支持！为了更好地管理项目，维护者有一些要求：
|
||||
>
|
||||
> 1. 请确保代码、配置文件的结构和命名规范良好，注释完善，并遵循阿里巴巴的 <a href="https://github.com/Charles7c/continew-admin/blob/dev/code-style/Java%E5%BC%80%E5%8F%91%E6%89%8B%E5%86%8C(%E9%BB%84%E5%B1%B1%E7%89%88).pdf" target="_blank">《Java开发手册(黄山版)》</a> 中的代码规范
|
||||
> 2. 在提交代码前，请按照 [Angular 提交规范](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular) 编写 commit 的 message（建议在 IntelliJ IDEA 中下载并安装 Git Commit Template 插件，以便按照规范进行 commit）
|
||||
> 3. 提交代码之前，请关闭所有代码窗口，执行 mvn compile 命令（项目已配置代码格式化插件，编译通过的同时也会自动进行代码格式化），编译通过后，不要再打开查看任何代码窗口，直接提交即可，以免不同的 IDE 配置会自动进行代码格式化
|
||||
|
||||
## 鸣谢
|
||||
|
||||
### 鸣谢
|
||||
|
||||
感谢参与贡献的每一位小伙伴！（以下排名不分先后）
|
||||
|
||||
<a href="https://github.com/Charles7c/continew-admin/graphs/contributors">
|
||||
<img src="https://contrib.rocks/image?repo=Charles7c/continew-admin" />
|
||||
</a>
|
||||
|
||||
### 特别鸣谢
|
||||
|
||||
- 感谢 <a href="https://www.jetbrains.com/" target="_blank">JetBrains</a> 提供的 <a href="https://www.jetbrains.com/shop/eform/opensource" target="_blank">非商业开源软件开发授权</a>
|
||||
- 感谢 <a href="http://pro.arco.design/" target="_blank">Arco Design Pro</a> 开箱即用的中后台前端解决方案
|
||||
- 感谢 <a href="https://github.com/baomidou/mybatis-plus" target="_blank">MyBatis Plus</a>、<a href="https://github.com/dromara/sa-token" target="_blank">Sa-Token</a> 、<a href="https://github.com/alibaba/easyexcel" target="_blank">Easy Excel</a>、<a href="https://github.com/xiaoymin/knife4j" target="_blank">Knife4j</a>、<a href="https://github.com/dromara/hutool" target="_blank">Hutool</a> 等国产开源组件作者为国内开源世界作出的贡献
|
||||
- 感谢 <a href="https://github.com/elunez/eladmin" target="_blank">ELADMIN</a>、<a href="https://github.com/dromara/RuoYi-Vue-Plus" target="_blank">RuoYi-Vue-Plus</a>、<a href="https://github.com/yangzongzhuan/RuoYi-Vue3" target="_blank">RuoYi-Vue3</a> 提供的诸多成熟方案，致敬各位作者为开源世界作出的贡献
|
||||
- 感谢 <a href="https://github.com/elunez/eladmin" target="_blank">ELADMIN</a>、<a href="https://github.com/dromara/RuoYi-Vue-Plus" target="_blank">RuoYi-Vue-Plus</a>、<a href="https://github.com/yangzongzhuan/RuoYi-Vue3" target="_blank">RuoYi-Vue3</a> 提供的诸多成熟方案，致敬各位作者为开源脚手架领域作出的贡献
|
||||
- 感谢项目使用或未使用到的每一款开源组件，致敬各位开源先驱 :fire:
|
||||
|
||||
## License
|
||||
|
||||
- 遵循 <a href="https://github.com/Charles7c/continew-admin/blob/dev/LICENSE" target="_blank">Apache-2.0</a> 开源许可协议
|
||||
- Copyright © 2022-present <a href="https://blog.charles7c.top" target="_blank">Charles7c</a>
|
||||
- Copyright © 2022-present <a href="https://blog.charles7c.top" target="_blank">Charles7c</a>
|
||||
|
||||
## GitHub Star 趋势
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user