开源项目贡献者指南

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

贡献方式

在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
相关推荐
cs_dn_Jie3 小时前
mac 通过 Homebrew 安装 git 遇到的问题
git·macos
雾恋6 小时前
AI导航工具我开源了利用node爬取了几百条数据
前端·开源·github
Wulitc7 小时前
GIT管理指令
git
XianxinMao7 小时前
Llama 3:开源大模型的里程碑式突破
开源·llama
shykevin8 小时前
DBSyncer开源数据同步中间件
中间件·开源
杰九10 小时前
我的世界(Minecraft)计算器python源码
python·开源·游戏程序
中科岩创10 小时前
广东某海水取排水管线工程边坡自动化监测
大数据·物联网
fan_00011 小时前
LKT4304新一代算法移植加密芯片,守护 物联网设备和云服务安全
物联网·安全
可涵不会debug11 小时前
Git 分支管理与多人协作实战指南
git
only-lucky12 小时前
Git克隆 提示证书验证失败解决
git