目录规范

参考文档《软件项目目录与文件管理规范-R3.1》的【目录结构】章节。要求如下：

仓库必须符合本节要求的目录结构

原则

宜采用浅的目录结构，或者称为扁平的目录结构。
可选文件和目录，应等到需要的时候再去建立。
目录和文件名应尽可能采用英文。
请注意，目录和文件名的大小写必须符合规定。这是因为考虑到 linux 平台的可移植性。
每个仓库的 doc/ 目录下都必须有 README.md 文件。
除 README.md 文档外，文档都尽量存储在 doc/ 目录下。
资源文件统一放到对应的和 .md 文档同级的 media 文档目录下。

git 服务器端的目录和文件结构

<project-name>/                     ; project root dir                       
    +-- doc/                                    
        +-- srs/
        +-- design/
        +-- manual                  
    +-- pm/                             
        +-- risk.md                             
        +-- roles.md                            
        +-- stakeholder.md
    +-- src/                                
    +-- test/                               
    +-- .editorconfig               ; or `.clang-format`                   
    +-- .gitattributes
    +-- .gitignore                      
    +-- README.md                       
    +-- <project-name>.sln

Note

《软件项目目录与文件管理规范.md》文档由软件部维护和发布，请参考当前最新版本。

另外：最近发现 phx 有 code-guildlines 文档，因考虑到该文档从研发阶段的产出考虑，属于编码阶段参考的文档，类似于srs，design，manual 文档，可以直接放到 doc 下。