开源项目贡献者指南

非常欢迎参与项目贡献,我们致力于维护一个互相帮助,共同成长社区。

贡献方式

在Fastbee 社区,贡献方式有很多:

  • 💻代码:可以帮助社区完成一些任务、编写新的feature或者是修复一些bug;
  • ⚠️测试:可以来参与测试代码的编写,包括了单元测试、集成测试、e2e测试;
  • ✅编译:构建或者辅助工具建议,包括:Docker,K8s,CI/CD,辅助调试工具等;
  • 📖文档:可以编写或完善文档,来帮助用户更好地了解和使用 物联网平台;
  • 🤔讨论:可以参与 Fastbee 新的feature的讨论,将您的想法跟 Fastbee 融合;
  • 💬建议:也可以对项目或者社区提出一些建议,促进社区的良性发展;
  • ❗疑问:问出一个好的问题,同样也可以促进项目发展,拓宽思考方向;

即便是小到错别字的修正我们也都非常欢迎 😃

让 Fastbee 运行起来

Fastbee物联网项目新手快速入门-CSDN博客.

提PR有以下注意点

PR统一在Gitee平台上进行提交,如果你不知道如何提交PR,可以在Gitee平台里去学习。这里不作说明。

  • fork后切换到develop分支,请以这个分支为开发基准。
  • 所有的PR提交到develop分支,这个分支为开发分支。
  • 如果你作了功能性的变动,请带上你的测试用例,测试用例规范可以参考之前的测试用例。
  • 所有的PR必须关联至少一个issue,如果没有相关issue,请自行创建一个。
  • 正式提交PR之前,请确保所有的测试用例都通过。
  • Git提交消息,需要按照Git提交规范

提交 Pull Request

  1. 首先您需要 Fork 目标仓库 Fastbee repository.

  2. 然后 用git命令 将代码下载到本地:

    复制代码
    git clone https://gitee.com/zhuangpengli/FastBee 
  3. 下载完成后,请参考目标仓库README 文件对项目进行初始化。

  4. 接着,您可以参考如下命令进行代码的提交, 切换新的分支, 进行开发:

    根据项目需要创建对应分支

    git checkout -b feat-xxx 或者 fix-xxx 等等

  5. 提交 commit , commit 描述信息需要符合约定格式.

    git add <modified file/path>
    git commit -m '[docs]feature: necessary instructions'

  6. 推送到远程仓库

    git push origin feat-xxx

  7. 然后您就可以在 Gitee 上发起新的 PR (Pull Request)。

注意!!! PR 的标题需要符合我们的规范,并且在 PR 中写上必要的说明,来方便 Committer 和其他贡献者进行代码审查。等待PR代码被合并
在提交了 PR 后,Committer 或者社区的小伙伴们会对您提交的代码进行审查(Code Review),会提出一些修改建议,或者是进行一些讨论,请及时关注您的PR。

若后续需要改动,不需要发起一个新的 PR,在原有的分支上提交 commit 并推送到远程仓库后,PR会自动更新。

代码被合并后

在代码被合并后,您就可以在本地和远程仓库删除这个开发分支了:

复制代码
git branch -d feat-xxx
git push origin --delete feat-xxx在主分支上,

您可以执行以下操作来同步上游仓库:

复制代码
git remote add upstream https://gitee.com/zhuangpengli/FastBee.git
#Bind the remote warehouse, if it has been executed, it does not need to be executed againgit checkout master git pull upstream master
相关推荐
宁静的舞者1 天前
Git、GitHub、Codeup(云效代码仓库)详解
git·代码仓库·codeup·云效
陈佬昔没带相机1 天前
Git Worktree: AI 编程 Agent 并行开发的秘密武器
git·agent
勇气要爆发1 天前
科技爱好者周刊(第 4 期):开源模型的“双响炮“:一周两款国产大模型开源
科技·开源
X.AI6662 天前
小米 MiMo‑V2.5 正式开源,Orbit 百万亿 Token 激励计划开放申请,速来撸资源
开源
电子科技圈2 天前
芯科科技在蓝牙亚洲大会展示汽车与边缘AI前沿蓝牙创新技术, 解锁车用、家居、健康及工商业等应用场景
人工智能·科技·嵌入式硬件·mcu·物联网·网络安全·汽车
redreamSo2 天前
让AI Agent自动接Issue、写代码、上线:我用200行代码搭了一个全自动开发流水线
人工智能·开源·github
三佛科技-134163842122 天前
PD65W快充电源方案LP8841SD+LP35118N(高频QR反激、BOM简洁,小体积,过认证)
单片机·嵌入式硬件·物联网·智能家居·pcb工艺
栈时没有名字2 天前
git仓库管理,commit或push上传服务器失败问题
git·嵌入式
sinovoip2 天前
香蕉派开源社区联合进迭进空重磅打造: BPI‑SM10(K3-Com260) 和 K3 Pico‑ITX 计算机将于5月11日全球发货
人工智能·开源·risc-v