文档添加书写规范

This commit is contained in:
zhangyiming 2020-11-17 17:04:06 +08:00
parent da35502733
commit 5cc990859d
6 changed files with 80 additions and 2 deletions

View File

@ -3,7 +3,31 @@
:tada: :100: :tada: :100:
::: tip ::: tip
``` ```
和尚 WeChat18237613535 和尚
``` ```
GitHubhttps://github.com/xiaoxian521 GitHubhttps://github.com/xiaoxian521
:::
:tada: :100:
::: tip
```
chenxi
```
GitHubhttps://github.com/chenxi19950223/wxnode
:::
:tada: :100:
::: tip
```
ChaoSuperScholar
```
GitHubhttps://github.com/ChaoSuperScholar/smallhouse
:::
:tada: :100:
::: tip
```
Yinwenxu
```
GitHubhttps://github.com/Yinwenxu/Student
::: :::

View File

@ -1,5 +1,7 @@
# description # description
### A system of adding, deleting, modifying and checking based on TS
## Main Technologies: ## Main Technologies:
| front end | after end | database | | front end | after end | database |
| -- |:--:| -- | | -- |:--:| -- |

View File

@ -1,3 +1,16 @@
# Writing Standard # Writing Standard
:tada: :100:
::: tip
① Interface documents use swagger
② The author must strictly abide by the tslint writing rules in the project
③ The author must strictly follow the code naming semantics and improve the readability of the code
④ The author must go through the unit test to ensure the usability of the code
⑤ Typescript must be used completely to ensure code rigor and maintainability
⑥ If the code submitted by the writer conflicts, it must be resolved first. In pushing, GIT push - f origin branch is strictly prohibited
⑦ Put Vue code under Vue TS branch, react code under react TS branch and angular code under angular TS branch
:::
::: danger
Managers are not allowed to push or merge the code directly into the main branch. The main branch is only used to store the back-end code and document code. In this way, it avoids the need to wait for a long time to pull the code for the first time. After the code is written as a whole, it will be merged into the main branch
:::

View File

@ -3,7 +3,31 @@
:tada: :100: :tada: :100:
::: tip ::: tip
``` ```
和尚 微信18237613535 和尚
``` ```
GitHubhttps://github.com/xiaoxian521 GitHubhttps://github.com/xiaoxian521
:::
:tada: :100:
::: tip
```
chenxi
```
GitHubhttps://github.com/chenxi19950223/wxnode
:::
:tada: :100:
::: tip
```
ChaoSuperScholar
```
GitHubhttps://github.com/ChaoSuperScholar/smallhouse
:::
:tada: :100:
::: tip
```
Yinwenxu
```
GitHubhttps://github.com/Yinwenxu/Student
::: :::

View File

@ -1,5 +1,7 @@
# 项目描述 # 项目描述
### 一套整体基于TS的增删改查系统
## 主要技术: ## 主要技术:
| 前端 | 后端 | 数据库 | | 前端 | 后端 | 数据库 |
| -- |:--:| -- | | -- |:--:| -- |

View File

@ -1,3 +1,16 @@
# 书写规范 # 书写规范
:tada: :100:
::: tip
① 接口文档使用Swagger
② 编写者必须严格遵守项目中tslint编写规则
③ 编写者必须严格遵循代码命名语义化、提高代码可读性
④ 编写者编写代码完毕必须经过单元测试,保证代码可用性
⑤ 编写必须完全使用TypeScript保证代码严谨性、可维护性
⑥ 编写者提交代码发生冲突必须先解决在推送严禁使用git push -f origin 分支
⑦ vue代码请放在vue-ts分支下react代码请放在react-ts分支下angular代码请放在angular-ts分支下
:::
::: danger
管理者严禁将代码直接推送或合并到main分支main分支只用来存放后端代码和文档代码这样避免了首次拉取代码需要等很长时间代码整体编写完毕后会合并到main分支
:::