开源项目贡献者指南

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

贡献方式

在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
相关推荐
Zkaisen5 分钟前
【Gitee】SSH 公钥、GPG 公钥、私人令牌的区别
运维·gitee·ssh
醉颜凉2 小时前
Jenkins与Git集成完全指南:从基础配置到自动触发构建
运维·git·jenkins
猫头虎2 小时前
GitHub 入门教程:如何加入并为开源项目贡献代码
gitee·开源·gitlab·github·开放原子·开源协议·gitcode
樱花落木兰2 小时前
Git 超全零基础教程|三区原理、全套命令、分支协作、冲突解决、IDEA 集成(面试必备)
ide·git·json·github
云和数据.ChenGuang3 小时前
git revert回退问题
java·服务器·人工智能·git·fastapi·强化学习
SL-staff3 小时前
技术实践:解决IoT网关单点故障导致子设备批量‘失联’问题
物联网·zigbee·边缘缓存·jvs·iot架构·物模型设计·设备生命周期
OpenCSG3 小时前
CSGHub:开源、用户反馈后企业版转社区版,持续开源
开源
TunerT_TQ3 小时前
IBM |css-gridish 源码分析:4 个 JavaScript 文件背后的 CSS Grid 可视化工具
开源·github·资讯
TunerT_TQ3 小时前
Hugging Face| Candle 源码分析:702 个文件背后的 Rust 深度学习框架架构
开源·github·资讯
伞伞悦读4 小时前
【第12期】Windows 开发环境备份与恢复:软件、环境变量、Git、conda 和 Docker 卷完整方案
git·docker·conda