开源项目贡献者指南

2024-01-25 07:44
文章标签 项目 开源 指南 贡献者

本文主要是介绍开源项目贡献者指南,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

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

贡献方式

在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 
  1. 下载完成后,请参考目标仓库README 文件对项目进行初始化。
  2. 接着,您可以参考如下命令进行代码的提交, 切换新的分支, 进行开发:
# 根据项目需要创建对应分支
git checkout -b feat-xxx 或者 fix-xxx 等等
  1. 提交 commit , commit 描述信息需要符合约定格式.
git add <modified file/path>
git commit -m '[docs]feature: necessary instructions' 
  1. 推送到远程仓库
git push origin feat-xxx 
  1. 然后您就可以在 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

这篇关于开源项目贡献者指南的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/642561

相关文章

Python中图片与PDF识别文本(OCR)的全面指南

《Python中图片与PDF识别文本(OCR)的全面指南》在数据爆炸时代,80%的企业数据以非结构化形式存在,其中PDF和图像是最主要的载体,本文将深入探索Python中OCR技术如何将这些数字纸张转... 目录一、OCR技术核心原理二、python图像识别四大工具库1. Pytesseract - 经典O

SpringMVC高效获取JavaBean对象指南

《SpringMVC高效获取JavaBean对象指南》SpringMVC通过数据绑定自动将请求参数映射到JavaBean,支持表单、URL及JSON数据,需用@ModelAttribute、@Requ... 目录Spring MVC 获取 JavaBean 对象指南核心机制:数据绑定实现步骤1. 定义 Ja

HTML5 getUserMedia API网页录音实现指南示例小结

《HTML5getUserMediaAPI网页录音实现指南示例小结》本教程将指导你如何利用这一API,结合WebAudioAPI,实现网页录音功能,从获取音频流到处理和保存录音,整个过程将逐步... 目录1. html5 getUserMedia API简介1.1 API概念与历史1.2 功能与优势1.3

springboot项目中整合高德地图的实践

《springboot项目中整合高德地图的实践》:本文主要介绍springboot项目中整合高德地图的实践,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一:高德开放平台的使用二:创建数据库(我是用的是mysql)三:Springboot所需的依赖(根据你的需求再

在Windows上使用qemu安装ubuntu24.04服务器的详细指南

《在Windows上使用qemu安装ubuntu24.04服务器的详细指南》本文介绍了在Windows上使用QEMU安装Ubuntu24.04的全流程:安装QEMU、准备ISO镜像、创建虚拟磁盘、配置... 目录1. 安装QEMU环境2. 准备Ubuntu 24.04镜像3. 启动QEMU安装Ubuntu4

SQLite3命令行工具最佳实践指南

《SQLite3命令行工具最佳实践指南》SQLite3是轻量级嵌入式数据库,无需服务器支持,具备ACID事务与跨平台特性,适用于小型项目和学习,sqlite3.exe作为命令行工具,支持SQL执行、数... 目录1. SQLite3简介和特点2. sqlite3.exe使用概述2.1 sqlite3.exe

一文详解如何在idea中快速搭建一个Spring Boot项目

《一文详解如何在idea中快速搭建一个SpringBoot项目》IntelliJIDEA作为Java开发者的‌首选IDE‌,深度集成SpringBoot支持,可一键生成项目骨架、智能配置依赖,这篇文... 目录前言1、创建项目名称2、勾选需要的依赖3、在setting中检查maven4、编写数据源5、开启热

SpringBoot项目配置logback-spring.xml屏蔽特定路径的日志

《SpringBoot项目配置logback-spring.xml屏蔽特定路径的日志》在SpringBoot项目中,使用logback-spring.xml配置屏蔽特定路径的日志有两种常用方式,文中的... 目录方案一:基础配置(直接关闭目标路径日志)方案二:结合 Spring Profile 按环境屏蔽关

从基础到进阶详解Pandas时间数据处理指南

《从基础到进阶详解Pandas时间数据处理指南》Pandas构建了完整的时间数据处理生态,核心由四个基础类构成,Timestamp,DatetimeIndex,Period和Timedelta,下面我... 目录1. 时间数据类型与基础操作1.1 核心时间对象体系1.2 时间数据生成技巧2. 时间索引与数据

Java SWT库详解与安装指南(最新推荐)

《JavaSWT库详解与安装指南(最新推荐)》:本文主要介绍JavaSWT库详解与安装指南,在本章中,我们介绍了如何下载、安装SWTJAR包,并详述了在Eclipse以及命令行环境中配置Java... 目录1. Java SWT类库概述2. SWT与AWT和Swing的区别2.1 历史背景与设计理念2.1.