参与贡献

感谢您关注 SuperRadar！我们是一个开放、包容、正在成长的开源社区，致力于围绕毫米波雷达感知，提供数据、工具与场景支持。无论您是开发者、设计师、技术作者，还是普通用户，只要您愿意分享智慧与热情，SuperRadar 都欢迎您的加入。

SuperRadar 官方Github仓库地址（对应各个开源毫米波雷达仓库合集：https://github.com/super-radar

以下所有参与方式均遵守 SuperRadar 社区行为守则与贡献指南。

一、为什么参与 SuperRadar？

  • 提升影响力：您的贡献将被社区用户看到，并被收录在官方贡献者名单中。
  • 获得成长：与社区开发者协作，提升编码、算法、项目协作能力。
  • 构建履历：成为 SuperRadar 的 Committer，为职业发展助力。
  • 获得奖励：核心贡献者可获得社区周边、证书等回馈。
  • 塑造产品：直接影响 SuperRadar 的发展方向与功能特性。

二、贡献方式全景

贡献类型 适合人群 参与难度
代码贡献 算法/嵌入式/前端开发者 中~高
文档贡献 技术作者、翻译爱好者 低~中
测试与 Bug 反馈 所有用户 低
社区支持与答疑 热心用户 低
活动组织与技术推广 布道师、社区运营 低~中
数据与算法实践 算法/嵌入式开发者 中

三、代码贡献

代码是 SuperRadar 的基石。我们使用 GitHub Flow 进行协作。

适合领域

  • 算法与数据处理：基于社区开放的 ADC 原始数据与点云数据，开展信号处理、目标检测、点云算法研究
  • 接口与工具：围绕社区开放的数据接口，开发数据读取、解析、可视化小工具
  • 场景验证：利用社区提供的真实场景数据，验证算法效果、撰写测试报告

第一步：寻找任务

  • 自己发现：您可以直接提交新功能或优化，先通过 论坛讨论可行性

第二步：开发流程

  1. Fork 对应仓库：https://github.com/orgs/Super-Radar/repositories
  2. 克隆到本地：git clone https://github.com/您的账号/<仓库名>
  3. 创建分支：git checkout -b feature/your-feature-name
  4. 编写代码并遵守规范：
    • 单元测试：新代码尽量提供对应测试
    • 文档同步：重要变更需更新对应的 README 或使用文档
  5. 提交变更
  6. 推送到远程
  7. 发起 Pull Request：前往 GitHub 对应的仓库创建 PR

第三步：PR 审核要求

  • 标题遵循 Conventional Commits 规范（feat/fix/docs/style/refactor/test/chore）
  • 描述中需说明"解决了什么问题"以及"如何验证"
  • 关联相关 Issue（Closes #123）
  • 至少一位 Maintainer 审核通过后合并

代码贡献者进阶路径

外部贡献者 → 活跃贡献者（多次合并） → Committer

第一步：寻找任务

  • 自己发现：您可以直接提交新功能或优化，先通过 论坛讨论可行性

第二步：开发流程

  1. Fork 对应仓库：https://github.com/orgs/Super-Radar/repositories
  2. 克隆到本地：git clone https://github.com/您的账号/<仓库名>
  3. 创建分支：git checkout -b feature/your-feature-name
  4. 编写代码并遵守规范：
    • 单元测试：新代码尽量提供对应测试
    • 文档同步：重要变更需更新对应的 README 或使用文档
  5. 提交变更
  6. 推送到远程
  7. 发起 Pull Request：前往 GitHub 主仓库创建 PR

第三步：PR 审核要求

  • 标题遵循 Conventional Commits 规范（feat/fix/docs/style/refactor/test/chore）
  • 描述中需说明"解决了什么问题"以及"如何验证"
  • 关联相关 Issue（Closes #123）
  • 至少一位 Maintainer 审核通过后合并

代码贡献者进阶路径

外部贡献者 → 活跃贡献者（多次合并） → Committer

四、文档贡献

SuperRadar 的文档与代码同样重要。

可以贡献的内容

  • 用户指南：快速开始、配置说明、API 手册
  • 开发者文档：架构设计、二次开发、本地调试
  • 教程与最佳实践：真实场景案例、性能调优、故障排查
  • 翻译：中英文互译，扩大项目影响力

文档贡献流程

  1. 进入仓库 /docs 目录
  2. 修改或新增 .md 文件
  3. 提交 PR，标题以 docs: 开头

文档风格提示

  • 使用清晰的标题层级（一级标题每页一个）
  • 代码块标明语言（python, bash 等）
  • 重要信息使用 > Note 或 > Warning 引用块
  • 配图请放置在 /docs/assets 并采用相对路径引用

📌 文档站地址：待补充

五、Bug 反馈

反馈 Bug 的最佳方式

使用 GitHub Issues（https://github.com/super-radar）并选择 Bug report 模板，务必提供：

  • 版本号（SuperRadar 版本、浏览器或 OS 版本）
  • 复现步骤（清晰、可操作）
  • 日志或截图（脱敏后提供）
  • 期望结果与实际结果对比

详细的 Bug 报告将获得 Community Contributor 称号，并被收录到版本发布致谢名单。

六、社区支持与答疑

一个好的项目不仅需要代码，更需要活跃的互助社区。

参与方式

  • 在社区论坛 / GitHub Issues 中回答新手的配置或使用疑惑
  • Review 其他用户的 Issue，尝试复现并补充信息
  • 在官方开发者社群（微信：添加社区小助手 SuperRadar01）中日常答疑
  • 撰写 FAQ：将常见问题整理成文档或论坛置顶帖

社区答疑活跃用户可获得 Community Hero 称号，并受邀参与社区交流活动。

七、活动组织与技术推广

您不必是资深开发者，也能通过组织活动或内容创作来扩大 SuperRadar 的影响力。

可做的事

  • 在所在城市组织 SuperRadar Meetup
  • 撰写技术博客或制作视频教程
  • 在技术大会发表 SuperRadar 相关分享
  • 运营 SuperRadar 社交媒体账号（知乎、B站等，转发、翻译、创意内容）

项目方支持

我们将为组织者提供：

  • 活动物料设计（易拉宝、贴纸、PPT 模板）
  • 社区周边礼品
  • 嘉宾邀请函与志愿者证书
  • 官方渠道活动宣传

有意请联系 community@chengtech.com，标题注明【活动合作】。

八、数据与算法实践

围绕社区开放的 ADC/点云数据·接口·工具·真实场景，开展数据处理、算法验证与可视化实践，丰富社区的实践案例库。

典型方向

  • 数据解析与格式转换工具
  • 点云可视化 Demo
  • 基于真实场景数据的目标检测/跟踪算法验证脚本
  • 信号处理与杂波抑制算法实验

成果可在社区论坛分享，被官方收录推荐给其他用户参考。

九、贡献者奖励计划

为了感谢您的付出，我们设计了多层级激励机制：

贡献类型 奖励形式
首个 PR 合并 贡献者证书 + 社区致谢
累计多个 PR 合并 社区周边礼品 + 贡献者称号
月度活跃贡献者 社区致谢 + 周边礼品
年度卓越贡献者 受邀参与社区交流活动 + 纪念礼品
关键安全漏洞报告 官方致谢，按情况给予回馈

所有奖励按实际情况发放，结果将在社区公布。

十、从哪里开始？

  1. 阅读文档：熟悉 SuperRadar 架构与使用方式
    → 文档站地址待补充

  2. 加入社区：

    • 官方开发者社群：添加社区小助手微信 SuperRadar01
    • GitHub：https://github.com/super-radar
    • 社区论坛：本网站「社区论坛」板块

  3. 认领首个任务：带 good-first-issue 标签的 Issue

  4. 发起讨论：如果不知道做什么，在论坛 / GitHub Discussions 中描述您的兴趣与技能，社区会给您建议

十一、行为准则

我们期望所有贡献者遵守 SuperRadar 行为准则。简单概括：

  • 相互尊重，专业协作
  • 拒绝任何骚扰、歧视、人身攻击
  • 保护其他成员的隐私与安全

完整版请见社区行为守则页面。

十二、常见疑问

问：我不是专业开发者，能参与吗？
答：当然。文档、测试、社区答疑、活动组织都不需要编写核心代码，同样非常宝贵。

问：提交 PR 后多久会得到回复？
答：维护者会尽快给出初评。复杂 PR 可能需要更多时间。

问：我可以开发与 SuperRadar 相关的衍生项目吗？
答：欢迎任何形式的创新，具体请遵循对应仓库的开源协议。

十三、联系我们

  • 贡献相关问题：community@chengtech.com
  • 社区活动合作：community@chengtech.com
  • 安全漏洞上报：community@chengtech.com（请勿在论坛/GitHub上公开提交）

期待您的加入，一起让 SuperRadar 成为雷达感知领域有温度的社区！

立即行动：Star 我们的仓库、分享给朋友、提交第一行代码或第一份反馈。SuperRadar 因您而更强大。