From 08673c0f853f2e0f825f07744cc2c0c53f133eb7 Mon Sep 17 00:00:00 2001 From: Robert He Date: Fri, 26 Sep 2025 12:57:08 +0800 Subject: [PATCH 01/17] docs: update README and add coding standards for C++ and Python Revised the README for clarity and structure. Added detailed coding standards for C++ and Python, including formatting guidelines and best practices for development environments. --- .vscode/settings.json | 16 +++ profile/README.md | 123 +++++++++++++++++------ profile/{standard.md => standard.cpp.md} | 21 ++-- profile/standard.py.md | 17 ++++ 4 files changed, 141 insertions(+), 36 deletions(-) create mode 100644 .vscode/settings.json rename profile/{standard.md => standard.cpp.md} (85%) create mode 100644 profile/standard.py.md diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..9b08c4d --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,16 @@ +{ + "cSpell.words": [ + "Altium", + "Arduino", + "autopep", + "Clion", + "HEADERFILE", + "ifndef", + "Keil", + "Robo", + "UNNC" + ], + "markdownlint.config": { + "no-inline-html": false + } +} \ No newline at end of file diff --git a/profile/README.md b/profile/README.md index 9403ab8..48b973c 100644 --- a/profile/README.md +++ b/profile/README.md @@ -1,47 +1,110 @@ -# 欢迎回到UNNC RoboMaster AIM战队 +# 欢迎回到 UNNC RoboMaster AIM 战队 -__本组织开放给所有AIM战队内成员使用，所有成员需遵守以下规范：__ -## __1. 仓库使用规范__ +**本组织开放给所有 AIM 战队内成员使用，所有成员需遵守以下规范：** -### 1.1 仓库命名规范 -本组织的仓库创建规范为：前缀-使用平台（如果有）-使用软件-仓库名 -其中前缀为： -* Hardware （对应硬件组） +## **1. 仓库使用规范** -* Embedded （对应软件组） +### 1.1 仓库命名规范 -* Vision （对应视觉组） +本组织的仓库创建规范为：前缀-使用平台（如果有）-使用软件-仓库名 +其中前缀为： -* Control （对应控制组） +- Hardware （对应硬件组） +- Embedded （对应软件组） +- Vision （对应视觉组） +- Control （对应控制组） 使用平台只有软件组成员需要填写： -* 软件组为使用硬件平台的名称，如：STM32，ESP32，Arduino之类 - -使用软件所有都需要填写： -* 控制组为使用ROS版本的名称，如：Noetic，Humble等 -* 视觉组为使用IDE的名称，如：VSCode，Clion，Pycharm等 +- 软件组为使用硬件平台的名称，如：STM32，ESP32，Arduino 之类 -* 软件组为使用IDE的名称，如：Keil，PIO，CubeIDE等 +使用软件所有都需要填写： -* 硬件组为使用硬件的名称，如：KiCAD，Cadence，AltiumDesigner等 +- 控制组为使用 ROS 版本的名称，如：Noetic，Humble 等 +- 视觉组为使用 IDE 的名称，如：VSCode，CLion，PyCharm 等 +- 软件组为使用 IDE 的名称，如：Keil，PIO，CubeIDE 等 +- 硬件组为使用硬件的名称，如：KiCAD，Cadence，AltiumDesigner 等 样例命名为： -**Hardware-KiCAD-HyperCap -Embedded-STM32-CubeIDE-Balance， -Control-Noetic-Infantry， -Vision-VSCode-PowerRune** -### 1.2 仓库内容规范 -所有仓库内 __不允许__ 出现任何编译文件，请妥善使用.gitignore文件来排除项目下所有潜在的编译文件 +**Hardware-KiCAD-HyperCap** +**Embedded-STM32-CubeIDE-Balance** +**Control-Noetic-Infantry** +**Vision-VSCode-PowerRune** -### 1.3 仓库进度管理 -所有仓库禁止直接向master分支直接提交修改，请创建分支并使用Push & Pull request来提交修改，分支命名规范需要符合以下要求： -* 新增功能无论有没有bug的按照功能的名字命名 +### 1.2 仓库内容规范 -* 阶段性成果没有显著问题的按照版本号命名 +所有仓库内 **不允许** 出现任何编译文件，请妥善使用.gitignore 文件来排除项目下所有潜在的编译文件 -* 保证所有功能稳定可靠的才可merge到master分支 +### 1.3 仓库进度管理 -### 1.4 代码规范 -[点击此处跳转](https://github.com/UNNC-AIM/.github/blob/v0.2/profile/standard.md) \ No newline at end of file +所有仓库禁止直接向 main 分支直接提交修改，请创建分支并使用 Push & Pull request 来提交修改，分支命名规范需要符合以下要求： + +- 新增功能无论有没有 bug 的按照功能的名字命名 + +- 阶段性成果没有显著问题的按照版本号命名 + +- 保证所有功能稳定可靠的才可 merge 到 main 分支 + +### 1.4 Git Message 规范 + +1. 推荐的 Git 提交信息格式 + + 基础格式： + + ```text + (): + + + +