组织介绍

搞事情实战笔记

仓库更新须知:

一、项目目录结构

  1. 根目录README.md是对本仓库的文件的一个综述性的说明, 并且可以附上一些相关性的文档链接
  2. p0代表第0周课程,p1代表第一周课程以此类推
  3. 一周课程目录里面结构如下:
path detail
code 课程练习代码
picture 图片放这里
README.md 当期课程笔记
xxx.pdf 课程pdf资料
docs 用于当期知识的扩展性文档,里面的每一条应当命名为xxx.md
.
├── p0
│   ├── 0808-DDD 落地成盒——为啥你写不好 DDD 代码-大明.pdf
│   └── READMD.md
├── p1
│   ├── 1. 进阶语法——并发编程.pdf
│   ├── code
│   ├── Go实战训练营课程简介.pdf
│   ├── picture
│   ├── README.md
│   └── 第一周作业:服务器优雅退出.pdf
└── README.md

二、README.md文档编写规范

为了统一README.md的格式,对于每期的笔记做一个最基本的约束:

  1. 一级标题(#)用于当期主题,唯一
  2. 二级标题(##)用于当期目录,数量一般不超过个位数, 需要用一、二、三...开头
  3. 三级标题(###),当期目录下的具体描述,如果再细分才可以使用四级标题(####);可以直接以内容文字开头
  4. 行文逻辑清晰,对于步骤性或者罗列内容采用1. 2. 3.进行组织
  5. 还未完成的部分用"TODO:"标记,防止忘记
  6. 代码均应该是以"代码框"形式, 杜绝代码截图;如果代码比较长可以从上述"code目录"中写,然后在README.md中写明是哪个路径
  7. 图片应当是课堂所讲的流程图等原理性图片

三、git commit规范

TODO:

成就
0
Star
0
Fork
成员(6)
5316363 gaoyangzhang 1660637966
张高玚
DQmyth
whisper2u
段飞
百里英骐
赵智博

搜索帮助