Skip to content

HBX-hbx/ReqMan-doc

 
 

Repository files navigation

ReqMan Docs

使用方式

依赖安装

pip install -r requirements.txt

开始编写

  • 创建新分支。
  • 在本地运行命令 mkdocs serve 打开在线预览,通过浏览器访问 http://127.0.0.1:8000/ 查看本地构建的文档。
  • 然后撰写对应的 Markdown 文件,确认效果后在根目录 commit 后 push 即可。
  • MR 合入 Master

写作规范

  • 新建文件用 LF,更改文件不得修改句末换行符,否则拒绝 MR
  • MR 由 项目总负责人∪前端负责人∪后端负责人 均可处理,其对应负责的部分
  • 遵循中文排版规范,不然会让 c7w 很伤心 :(

About

The doc of Software Engineering Project

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • HTML 52.0%
  • Dockerfile 48.0%