| README.md | ||
Gitea 仓库使用及规范
Gitea背景
Gitea是一个可以自建的Github服务,考虑到整体项目的敏感性,所以通过私有部署的方式来替代Github的功能,但目前由于性能限制,未测试CI/CD的功能,仅用于代码版本管理及多地协作;
目前网站网址为: https://gitea.ac.oispace.eu.org。 网络结构是通过云服务器PS作内网穿透,本身Gitea 是搭建在NAS上的,VPS起到了公网IP和网络转发的功能,利用的是Frp来实现
账号管理
目前网址是禁用自行注册的,需要注册的同学可以联系我来内部注册。
规范相关
使用规范
目前有四人在ZD-Project组织中:柳梦圆、罗林赖生、孟佳庆、谢伟民;后续可能会陆续增加。组织仓库中主要维护的是重点项目中的代码,目前先试点SP713的上位机,后续逐渐增加相应的代码仓库,如果有增加,就
SP713_Upper_C:C/C++版本上位机,README每次合并主线的时候,更新一次;单项测试用;SP713_Upper_Python:python版本上位机,README每次合并主线的时候,更新一次;最终集成用;SP713_Upper_Exec: 上位机的可执行文件,分为两个文件夹,一个是Python,一个是C;Tools: 可能用上的工具
一定需要注意的点:
- 代码上的应该隐去的,一定要隐去敏感信息;
- 每个人手里一定有一份完整的代码备份,以防万一中心系统崩溃,冷备份由柳梦圆每周输出一次备份;
- 注意信息安全,不必要的信息一定不要上传;
- 罗林赖生为主控制人,负责主版本的控制;
开发规范
基于目前的代码情况,现作出一个版本规范:
C/C++版本是基于QT(5.15.2)+ GCC实现(基于Linux实现), C++统一用C11版本;make版本使用qmake,gcc不作额外版本指定;Python版本是基于python 3.10.10,venv需要打包;
包管理: SP713-UART250711.py中包含以下扩展库: ctypes time logging typing csv datetime os
仓库管理规范
- 仓库中只管理源代码,其他的代码(build或者其他的个人配置不允许上传,请配置好
git ignore) - 各个模块尽量有输入是什么,输出是什么,并用一句话来描述该模块的功能;
main为主分支,其他分支的开发命名以feature-xx-date/bug-xx-date,合并只有罗林赖生才能控制;- 新建组织仓库必须经过罗林赖生同意,个人仓库不作限制;
commit建议总结完善;- 远端仓库统一为
origin,即remote set-url origin xxx
关于Git的协作方式
目前协作方式还没于找到一个比较合适的教程,希望大家可以共同来完善这一部分的文档,如果有外部引用和链接,也可以直接贴上来。
目前已有的教程:
- Nas上内网穿透后的Gitea使用教程 :讲述如何通过配置PAT来实现远端仓库
push
其他
大家如果有自己的代码可以上传到平台上作自己的代码管理,不针对个人进行要求,自行维护好自己的代码,尽可能保证规范,这样方便自己调试,也方便其他人能够快速理解。
版本号说明
v2.3驱动板版本,对应v1.1.x;V5.0驱动板版本,对应v2.0;V5.1驱动板版本,对应v2.1;