From 5cc990859dfa12cd14d67c53f409e17fcdd310d3 Mon Sep 17 00:00:00 2001 From: zhangyiming Date: Tue, 17 Nov 2020 17:04:06 +0800 Subject: [PATCH] =?UTF-8?q?=E6=96=87=E6=A1=A3=E6=B7=BB=E5=8A=A0=E4=B9=A6?= =?UTF-8?q?=E5=86=99=E8=A7=84=E8=8C=83?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- doc/docs/en/introduction/contributor.md | 26 ++++++++++++++++++++++++- doc/docs/en/introduction/description.md | 2 ++ doc/docs/en/standard/index.md | 13 +++++++++++++ doc/docs/zh/introduction/contributor.md | 26 ++++++++++++++++++++++++- doc/docs/zh/introduction/description.md | 2 ++ doc/docs/zh/standard/index.md | 13 +++++++++++++ 6 files changed, 80 insertions(+), 2 deletions(-) diff --git a/doc/docs/en/introduction/contributor.md b/doc/docs/en/introduction/contributor.md index fb3676994..43b394083 100644 --- a/doc/docs/en/introduction/contributor.md +++ b/doc/docs/en/introduction/contributor.md @@ -3,7 +3,31 @@ :tada: :100: ::: tip ``` -和尚 WeChat：18237613535 +和尚 ``` GitHub：https://github.com/xiaoxian521 +::: + +:tada: :100: +::: tip +``` +chenxi +``` +GitHub：https://github.com/chenxi19950223/wxnode +::: + +:tada: :100: +::: tip +``` +ChaoSuperScholar +``` +GitHub：https://github.com/ChaoSuperScholar/smallhouse +::: + +:tada: :100: +::: tip +``` +Yinwenxu +``` +GitHub：https://github.com/Yinwenxu/Student ::: \ No newline at end of file diff --git a/doc/docs/en/introduction/description.md b/doc/docs/en/introduction/description.md index 4bf16332e..e2d6f4359 100644 --- a/doc/docs/en/introduction/description.md +++ b/doc/docs/en/introduction/description.md @@ -1,5 +1,7 @@ # description +### A system of adding, deleting, modifying and checking based on TS + ## Main Technologies: | front end | after end | database | | -- |:--:| -- | diff --git a/doc/docs/en/standard/index.md b/doc/docs/en/standard/index.md index 44477e613..1ae379886 100644 --- a/doc/docs/en/standard/index.md +++ b/doc/docs/en/standard/index.md @@ -1,3 +1,16 @@ # 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 +::: \ No newline at end of file diff --git a/doc/docs/zh/introduction/contributor.md b/doc/docs/zh/introduction/contributor.md index c4db91b26..ebe5c3810 100644 --- a/doc/docs/zh/introduction/contributor.md +++ b/doc/docs/zh/introduction/contributor.md @@ -3,7 +3,31 @@ :tada: :100: ::: tip ``` -和尚 微信：18237613535 +和尚 ``` GitHub：https://github.com/xiaoxian521 +::: + +:tada: :100: +::: tip +``` +chenxi +``` +GitHub：https://github.com/chenxi19950223/wxnode +::: + +:tada: :100: +::: tip +``` +ChaoSuperScholar +``` +GitHub：https://github.com/ChaoSuperScholar/smallhouse +::: + +:tada: :100: +::: tip +``` +Yinwenxu +``` +GitHub：https://github.com/Yinwenxu/Student ::: \ No newline at end of file diff --git a/doc/docs/zh/introduction/description.md b/doc/docs/zh/introduction/description.md index 05f01ec3b..e8fa1b5e6 100644 --- a/doc/docs/zh/introduction/description.md +++ b/doc/docs/zh/introduction/description.md @@ -1,5 +1,7 @@ # 项目描述 +### 一套整体基于TS的增删改查系统 + ## 主要技术： | 前端 | 后端 | 数据库 | | -- |:--:| -- | diff --git a/doc/docs/zh/standard/index.md b/doc/docs/zh/standard/index.md index 728daccba..e9adb9d7c 100644 --- a/doc/docs/zh/standard/index.md +++ b/doc/docs/zh/standard/index.md @@ -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分支 +::: \ No newline at end of file