PasteUs README

PasteUs 团队新人指引

1. 贡献内容

如果需要为此文档贡献内容，请仔细阅读本节。

1.1 添加 md 文件

在本仓库下，选择一个合适的位置，放入 .md 格式的文件。也可直接点击新建文件的链接。

1.2 将文档添加进侧边栏

参考 docsify 定制侧边栏

添加完 .md 文件之后，在 _sidebar.md 中按照格式引入此文件即可。

1.3 预览更改

可通过运行本仓库根目录下的 serve.sh 来预览修改后的页面，地址为 http://localhost:3000。

sh serve.sh

2. 加入我们

欢迎各位小伙伴加入我们：join.pasteme.cn

QQ 群：

3. 规约

3.1 Java

每个 *.java 文件必须加上 @author ，代表参与编写的人，多个人用英文逗号分隔，, 后面需有空格
每个 *.java 工程文件必须加上 @version，在文件变更时对 @version 进行相应的变更
- 2.1 小修补之类的对末位进行更改，如 1.0.0 -> 1.0.1
- 2.2 有功能上的更新，对中间位进行更改，如 1.0.0 -> 1.1.0
- 2.3 有较大更新，且移除或 不兼容 以往的接口，对首位进行变更，如 1.0.0 -> 2.0.0

/**
 * @author Lucien, Irene
 * @version 1.0.0
 */
public class Example {}

日志一律使用 @Slf4j
不允许直接变更 dev、master 分支，需 clone 至自己的仓库之后进行 pull request
请务必遵守阿里巴巴 Java 代码规范 https://github.com/alibaba/p3c
请使用 Alibaba 代码规约插件 https://github.com/alibaba/p3c/tree/master/idea-plugin

3.2 Git

请正确配置 git config user.name 以及 git config user.email
git commit 时请尽可能使用英文
在进行更改时先将项目克隆至自己的仓库，然后新建一个分支，分支名格式为 feature/<feature_name> 或 bugfix/<bug_name>，譬如 feature/check_result_support、bugfix/fix_sql_error，然后发 pull request 至项目的 dev 分支。
对 git 不熟悉的话请先学习如何使用 git，以免浪费不必要的时间。推荐一个学习 git 的网站：learngitbranching.js.org，中文版：learngitbranching.js.org/?locale=zh_CN。

3.3 Markdown

https://github.com/ruanyf/document-style-guide

3.4 Commits、Issues 等排版

https://github.com/sparanoid/chinese-copywriting-guidelines/blob/master/README.zh-CN.md

4. PasteMe 项目进度

https://github.com/orgs/PasteUs/projects/1

4.1 参与开发

大致分以下几个步骤：

开发
功能自测
向 dev 分支提交 pull request，review 通过后合并至 dev
dev 环境线上功能自测
联调（如果需要）
验收测试
上线

5. 线上环境

目前线上的项目为 PasteUs/PasteMeFrontend 和 PasteUs/PasteMeGoBackend

对项目分支的更改将直接影响到线上的服务，请谨慎。

分支和线上的映射关系如下：

分支 / Tag	网址
release	pasteme.cn
master	beta.pasteme.lucien.ink

6. 项目说明

6.1 PasteMe 系

6.1.1 Java

项目	作用	依赖
PasteMeRoot	所有项目的 `parent`，作统一版本控制	无
PasteMeCommon	PasteMeBackend、PasteMeAdmin 共同的部分会下沉至 common 模块	PasteMeRoot
PasteMeJavaBackend	PasteMe 的 Java 后端，主要负责 Paste 的增改，因为 PasteMeGoBackend 的存在，所以起名 JavaBackend 以区分	PasteMeRoot、PasteMeCommon
PasteMeAdmin	PasteMe 后台管理模块，主要负责 Paste 的管理，以及算法业务化	PasteMeRoot、PasteMeCommon、PasteMeAlgorithm
PasteMeAlgorithm	PasteMe 算法模块，主要负责各种算法实现	PasteMeRoot

6.1.2 Vue

项目	作用	依赖
PasteMeFrontend	PasteMe 前端	无
PasteMeMonitor	PasteMe 监控模块，监控前后端的运行情况	无

6.1.3 Golang

项目	作用	依赖
PasteMeLite	由于很多小伙伴并不太会部署，所以提供 Lite 版，做到随处执行，随处使用	PasteMeGoBackend、PasteMeFrontend
PasteMeGoBackend	PasteMe 后端 Golang 实现的版本，线上准备切换至 Java 版本，Go 版本并入 PasteMeLite 项目	无

6.2 其它

项目	作用	依赖
pasteus.github.io	PasteUs 项目组 GitPages 页面，PasteMeMonitor 寄存在这里	PasteMeMonitor
CDN	前端的内容分发网络	无
MavenRepository	团队 Maven 仓库	无
README	团队新人指引	无