Skip to content

submit_notes

Haidong Wang edited this page Apr 4, 2026 · 3 revisions

提交注意事项


注意使用markdown渲染出来看下,是否显示正常

约定python代码用.py格式,ipynb没法对比,需要将ipynb转成.py文件

最多只能放1-2个示例数据(5M以内)用于跑通代码,其他所有图片放在一个永久网盘链接中提供下载(README.md中说明下载后放到哪个相对路径下),避免仓库太大。

有训练过程的代码需要贴出训练的过程(loss下降图或奖励上升图)

文件的编码方式符合规范,需要使用UTF-8编码

不能一直用这种手动设计的策略,而是需要用神经网络等方法来学习

Pull Requst尽量提供运行效果图(使用录屏软件,比如 OBS Studio ),有效果提升的需要有计算精确率、召回率等指标和计算脚本。

当超过2张图片等二进制文件时,在README.md中提供百度网盘或谷歌网盘下载链接,并说明使用方法。

提运行问题的Issue时,要贴上操作系统、模拟器版本、复现问题脚本、报错日志等,保证想帮的人能够复现错误

代码中不能使用绝对路径,需要改成相对路径,不然测试时没有你的这个路径(要保证不修改代码的情况下在另一台机器上能跑)

PR的标题没有总结所修改的具体内容,不能随意或者使用修改文件等默认的标题

程序运行示意图放在 PR 说明界面,不是仓库

.vs、.idea 等开发工具配置文件夹不能提交到仓库

解决完问题(Issues)记得关闭

不要用中文拼音作为文件名

使用main.launch文件启动ROS节点

Pr绑定Issues

Pr绑定issue,解决后关闭

重命名模块名不能太大,越具体越好

文件名不能包含空格和中文,后缀名符合特定功能要求(比如文档以.md为后缀),单词之间可以用下划线_分隔,用下划线后首字母就不要大写

检查修改文件个数,一般不能超过10个

说明所参考项目的来源

工程文件夹不需要添加,检查是否有冲突

不能过渡依赖大模型,大模型的输出需要理解和加工

action 添加 python 测试

新建分支同时开发多个功能

Clone this wiki locally