Skip to content
郭孝星 edited this page Mar 29, 2018 · 10 revisions

文章认领

文章认领可以直接对README提交PR,添加作者栏或者校对栏下方的名字,名字模板如下所示:

[xxx](https://github.com/xxx)

另外,如果有新的文章向添加进来,也可以直接对文章目录提交PR。

👉 注:认领文章后需要将你在QQ群或者微信群里的备注改成Github上的名字,方便大家协作。

文章编写

文章规范

文章整体结构可以参照:文章规范

文章目录

👉 注:文章与图片要放在对应的目录下,并以当前模块名来命名。

文章目录

图片目录

绘图规范

绘图工具一律采用OmniGraffle。

流程图、类图、时序图、系统架构图等各种图例采用OmniGraffle来绘制,Visio也比较好用,可惜Mac下没有。

OmniGraffle

UML类图、序列图、架构图在art目录下都有标准模板:

Clone this wiki locally