开源项目贡献者指南

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

相关文章

Apache Ignite 与 Spring Boot 集成详细指南

《ApacheIgnite与SpringBoot集成详细指南》ApacheIgnite官方指南详解如何通过SpringBootStarter扩展实现自动配置,支持厚/轻客户端模式,简化Ign... 目录 一、背景:为什么需要这个集成? 二、两种集成方式(对应两种客户端模型) 三、方式一:自动配置 Thick

SQL Server跟踪自动统计信息更新实战指南

《SQLServer跟踪自动统计信息更新实战指南》本文详解SQLServer自动统计信息更新的跟踪方法,推荐使用扩展事件实时捕获更新操作及详细信息,同时结合系统视图快速检查统计信息状态,重点强调修... 目录SQL Server 如何跟踪自动统计信息更新:深入解析与实战指南 核心跟踪方法1️⃣ 利用系统目录

使用IDEA部署Docker应用指南分享

《使用IDEA部署Docker应用指南分享》本文介绍了使用IDEA部署Docker应用的四步流程:创建Dockerfile、配置IDEADocker连接、设置运行调试环境、构建运行镜像,并强调需准备本... 目录一、创建 dockerfile 配置文件二、配置 IDEA 的 Docker 连接三、配置 Do

Python进行JSON和Excel文件转换处理指南

《Python进行JSON和Excel文件转换处理指南》在数据交换与系统集成中,JSON与Excel是两种极为常见的数据格式,本文将介绍如何使用Python实现将JSON转换为格式化的Excel文件,... 目录将 jsON 导入为格式化 Excel将 Excel 导出为结构化 JSON处理嵌套 JSON:

深入浅出SpringBoot WebSocket构建实时应用全面指南

《深入浅出SpringBootWebSocket构建实时应用全面指南》WebSocket是一种在单个TCP连接上进行全双工通信的协议,这篇文章主要为大家详细介绍了SpringBoot如何集成WebS... 目录前言为什么需要 WebSocketWebSocket 是什么Spring Boot 如何简化 We

Python极速搭建局域网文件共享服务器完整指南

《Python极速搭建局域网文件共享服务器完整指南》在办公室或家庭局域网中快速共享文件时,许多人会选择第三方工具或云存储服务,但这些方案往往存在隐私泄露风险或需要复杂配置,下面我们就来看看如何使用Py... 目录一、android基础版:HTTP文件共享的魔法命令1. 一行代码启动HTTP服务器2. 关键参

Python对接支付宝支付之使用AliPay实现的详细操作指南

《Python对接支付宝支付之使用AliPay实现的详细操作指南》支付宝没有提供PythonSDK,但是强大的github就有提供python-alipay-sdk,封装里很多复杂操作,使用这个我们就... 目录一、引言二、准备工作2.1 支付宝开放平台入驻与应用创建2.2 密钥生成与配置2.3 安装ali

Redis MCP 安装与配置指南

《RedisMCP安装与配置指南》本文将详细介绍如何安装和配置RedisMCP,包括快速启动、源码安装、Docker安装、以及相关的配置参数和环境变量设置,感兴趣的朋友一起看看吧... 目录一、Redis MCP 简介二、安www.chinasem.cn装 Redis MCP 服务2.1 快速启动(推荐)2.

OpenCV在Java中的完整集成指南分享

《OpenCV在Java中的完整集成指南分享》本文详解了在Java中集成OpenCV的方法,涵盖jar包导入、dll配置、JNI路径设置及跨平台兼容性处理,提供了图像处理、特征检测、实时视频分析等应用... 目录1. OpenCV简介与应用领域1.1 OpenCV的诞生与发展1.2 OpenCV的应用领域2

MyBatis-Plus 自动赋值实体字段最佳实践指南

《MyBatis-Plus自动赋值实体字段最佳实践指南》MyBatis-Plus通过@TableField注解与填充策略,实现时间戳、用户信息、逻辑删除等字段的自动填充,减少手动赋值,提升开发效率与... 目录1. MyBATis-Plus 自动赋值概述1.1 适用场景1.2 自动填充的原理1.3 填充策略