Skip to content

Latest commit

 

History

History
10 lines (9 loc) · 1.68 KB

Upload_Specification.md

File metadata and controls

10 lines (9 loc) · 1.68 KB

该文档用于说明在各个文件夹下上传内容的规范以及方法

文件组织方式

  1. 整个仓库主要通过四个文件夹来组织学习资源
  2. Docs文件夹下存放关于仓库的使用方法以及上传规范,是仓库的使用说明书
  3. Competition文件夹下存放的是与竞赛强相关的内容,该文件夹的子项应直接以竞赛名称命名进行归类。竞赛文件夹下一般有两个子文件夹:project、reference,project文件夹内上传赛题工程及赛题相关资料,该文件夹上传应当以当界赛题名称进行命名,同一个赛题下由不同届成员上传各自内容时应当新建以自己id命名或以时间命名的文件夹以便区分。reference文件夹下存放关于竞赛的整体说明或相关文档,而不是工程文件。
  4. Module文件夹下存放通用的模块示例文档,应当以功能分类建立子文件夹。各模块上传的文件夹应直接以模块名进行命名,文件夹内至少包含该模块的.c与.h文件同时应在这两个文件中给出调用示例、作者。如果后续使用有优化应当在该文件夹下新建version2的版本文件,并包含新的内容。如果是上传以实现某个功能为目的的工程模板,应包含可能需要的必要头文件以及版本说明。
  5. Skill_Developing文件夹是存放以教程或电子书为主的文件夹,也应当以工具或目的进行分类。

上传规范

main分支已开启保护,当提交pr时请在commit中说明改动位置,例如:在Competition/LanQiaoBei/下新建了“xxx”文件,同时新上传文件请以前文组织方式中的命名规则进行命名。