网站服务部小组文档

Git项目规范初稿

Git项目中,需要按照以后结构

    src -- //源代码存放
    dist -- //发布文件(如果有编译的需要的话)
    relate -- //项目相关内容(例如一些项目的资料:技能数据列表、头像关系映射、需求文档等)
    README.md -- //项目说明文件,采用markdown语法

项目文件须知

  1. 禁止放PSD的文件
  2. 禁止放超过50M的视频、图片文件
  3. 禁止提交调试文件(例如在开发过程产生的临时文件等)

项目说明文件

README.md文件中需包含以下说明,Demo可参考主公莫慌

  1. 项目的线上访问路径
  2. 源码结构简单说明
  3. 发布路径说明
  4. 使用须知(使用此项目需要注意以及安装什么之类)

Markdown语法