Flutter Dojo设计之道——利用Github打造完善的开源项目

Stella981
• 阅读 423

Flutter Dojo从最开始就准备打造成一个专业的GitHub开源项目。

一个好的GitHub开源项目,不仅仅是一个开发者专业技术的体现,更是一个自我展示的平台,专业的GitHub开源项目,可以吸引更多的开发者参与到项目的协同开发中来,让项目能够健康持续的发展。

下面我将根据Flutter Dojo的开发经历,来讲下如何借助GitHub打造完善的开源项目。

个性化个人主页

GitHub主页给了开发者一个公开的个人展示界面,不用搭建服务器,你就可以免费获得一个属于自己的展示页面,不过这也是GitHub的一个彩蛋功能,首先,你需要创建一个新的repository,并将其命名为你的用户名,如图所示。

Flutter Dojo设计之道——利用Github打造完善的开源项目

这时候你就会发现,同名的repository是一个GitHub彩蛋,你只需要在这个同名的Repo中的README.md中创建自己的主页即可,例如我的主页,如图所示。

Flutter Dojo设计之道——利用Github打造完善的开源项目

这个页面实际上就是通过README.md方式来进行展示的,实际上功能比较有限,但是通过

github-readme-stats

这个项目,也可以给简单的md界面创建一些有意思的东西,例如我的界面中的GitHub Stats和项目卡片,使用方法在这个Repo中都写的很清楚了,大家可以根据自己的需要,搭建属于自己的GitHub个人主页。

写好README.md

项目中的README.md文件,是GitHub项目主页展示的页面文件,一个好的README文件,是一个好的开源项目的基础,README的格式并没有什么要求,但和写作文一样,我觉得一个好的README文件,应该包含下面几个部分。

  • 项目的开发经历,初衷。当然这部分不一定需要,只是为了给开发者介绍项目的背景,让大家知道为什么会有这个项目。

  • 项目的功能、特色。这点很重要,GitHub上的开源项目多如牛毛,开发者很看一眼项目就知道这个项目是干什么的,所以,介绍项目的特色、功能,是让其他开发者对你的项目有一个第一印象。

  • 项目的接入方式、使用方式。这是让开发者能够使用你的开源项目的核心,良好的接入文档,可以提升开发者对项目的好感度。

  • 图。一图胜千言,开源项目一定要有一些设计图,例如项目的截图、功能的展示图、流程图、数据流转图等等。

  • CHANGELOG。CHANGELOG是开发者维护版本的重要工具,好的版本记录,可以让使用者了解不同版本之间的区别,了解项目的开发进程。

Flutter Dojo的README虽然不够完美,但基本涵盖了我上面提到的这些点,供大家参考。

Flutter Dojo的设计之道

Github shields

shields是在README中展示的一些小图标,在很多的开源项目中都有使用,例如Dojo中的shields。

Flutter Dojo设计之道——利用Github打造完善的开源项目

这些shields的生成,实际上都是一些svg图片,下面这个网站就是shields的创建网站。

shields

借助这个网站,可以非常轻松的创建这些有意思的shields,例如输入Flutter Dojo的项目地址,它会自动生成建议的shields,如图所示。

Flutter Dojo设计之道——利用Github打造完善的开源项目

把这些链接直接贴到README中即可展示。这个网站的功能非常强大,可以定义出很多的shields,感兴趣的开发者可以在网站上搭配出自己的shields。

开源协议的选择

开源协议的选择,是开源项目的一个重要部分,在国内,可能大家对开源协议的理解还不是很深入,但是在国外,开源协议的约束是非常重的,开发者会自发的遵守源项目的开源协议,这里借用阮一峰的一张图,来简单的理解下开源协议的种类。

Flutter Dojo设计之道——利用Github打造完善的开源项目

使用Github Action打造自动化CI

GitHub Action是一个非常实用的功能,在我们企业级的项目中,CI是一个非常重要的部分,它包含了代码的审核、提交、自动编译等流程的自动化,而GitHub Action正是这样一个简单的CI功能。

Flutter Dojo设计之道——利用Github打造完善的开源项目

在Flutter Dojo中,正是借助了这一功能来实现在提交Tag后自动编译最新的Apk包的功能。

Flutter Dojo设计之道——利用Github打造完善的开源项目

创建项目的Action非常简单,根据GitHub页面上的提示一步步完成即可,这里简单的介绍下Flutter Dojo的Actions模板。

on:

有了GitHub Action,Flutter Dojo每次发版的时候,只需要push一个tag,Action就会自动触发,并编译出相应的Apk。

Flutter Dojo设计之道——利用Github打造完善的开源项目

根据官方提供的模板,可以非常轻松的完成CI脚本的配置,基本上都是插件化开发,通过uses关键字引用相关功能的Action插件,就可以完成相应的功能。

而且,GitHub还提供了很多现成脚本的市场,可以让绝大部分的项目通过搭积木的方式快速搭建自己的脚本代码。

官方marketplace

第三方awesome-actions

Flutter Dojo借助GitHub,实现了一个比较完整的开发流程,除了上面提到的这些部分,Dojo还创建了Wiki和issue模板,Wiki可以管理更多的项目说明文档,issue模板,则为使用者反馈问题提供了便利,同时减少了开发者与反馈者的沟通成本。

Flutter Dojo设计之道——利用Github打造完善的开源项目

当然,Wiki还在编写之中,所以文档还在丰富的过程中,基本会以每周一篇的速度,将Flutter Dojo进行一次彻底的分析。

Flutter Dojo设计之道——利用Github打造完善的开源项目

反馈者可以选择不同的issue模板,并在该模板中了解到开发者所需要的信息,这样可以完善issue并提高效率。

Flutter Dojo设计之道——利用Github打造完善的开源项目

经过上面的这些打造,Flutter Dojo已经算是一个成熟的GitHub开源项目了,希望它早日能学会自己修bug。

本文分享自微信公众号 - Android群英传(android_heroes)。
如有侵权,请联系 support@oschina.cn 删除。
本文参与“OSC源创计划”,欢迎正在阅读的你也加入,一起分享。

点赞
收藏
评论区
推荐文章
blmius blmius
2年前
MySQL:[Err] 1292 - Incorrect datetime value: ‘0000-00-00 00:00:00‘ for column ‘CREATE_TIME‘ at row 1
文章目录问题用navicat导入数据时,报错:原因这是因为当前的MySQL不支持datetime为0的情况。解决修改sql\mode:sql\mode:SQLMode定义了MySQL应支持的SQL语法、数据校验等,这样可以更容易地在不同的环境中使用MySQL。全局s
Wesley13 Wesley13
2年前
java将前端的json数组字符串转换为列表
记录下在前端通过ajax提交了一个json数组的字符串,在后端如何转换为列表。前端数据转化与请求varcontracts{id:'1',name:'yanggb合同1'},{id:'2',name:'yanggb合同2'},{id:'3',name:'yang
Jacquelyn38 Jacquelyn38
2年前
2020年前端实用代码段,为你的工作保驾护航
有空的时候,自己总结了几个代码段,在开发中也经常使用,谢谢。1、使用解构获取json数据let jsonData  id: 1,status: "OK",data: 'a', 'b';let  id, status, data: number   jsonData;console.log(id, status, number )
皕杰报表之UUID
​在我们用皕杰报表工具设计填报报表时,如何在新增行里自动增加id呢?能新增整数排序id吗?目前可以在新增行里自动增加id,但只能用uuid函数增加UUID编码,不能新增整数排序id。uuid函数说明:获取一个UUID,可以在填报表中用来创建数据ID语法:uuid()或uuid(sep)参数说明:sep布尔值,生成的uuid中是否包含分隔符'',缺省为
Wesley13 Wesley13
2年前
(转)直接拿来用!最火的iOS开源项目(二)
“每一次的改变总意味着新的开始。”这句话用在iOS上可谓是再合适不过的了。GitHub上的iOS开源项目数不胜数,iOS每一次的改变,总会引发iOS开源项目的演变,从iOS1.x到如今的iOS7,有的项目已经被弃用,即使曾经的它很受开发者喜爱,有的项目则继续发扬光大,新项目更是层出不穷。在本文中,我们将继续为大家介绍20个在GitHub上非常受开发者欢迎
Wesley13 Wesley13
2年前
Java日期时间API系列36
  十二时辰,古代劳动人民把一昼夜划分成十二个时段,每一个时段叫一个时辰。二十四小时和十二时辰对照表:时辰时间24时制子时深夜11:00凌晨01:0023:0001:00丑时上午01:00上午03:0001:0003:00寅时上午03:00上午0
Stella981 Stella981
2年前
Django中Admin中的一些参数配置
设置在列表中显示的字段,id为django模型默认的主键list_display('id','name','sex','profession','email','qq','phone','status','create_time')设置在列表可编辑字段list_editable
Stella981 Stella981
2年前
Linux日志安全分析技巧
0x00前言我正在整理一个项目,收集和汇总了一些应急响应案例(不断更新中)。GitHub地址:https://github.com/Bypass007/EmergencyResponseNotes本文主要介绍Linux日志分析的技巧,更多详细信息请访问Github地址,欢迎Star。0x01日志简介Lin
Wesley13 Wesley13
2年前
MySQL部分从库上面因为大量的临时表tmp_table造成慢查询
背景描述Time:20190124T00:08:14.70572408:00User@Host:@Id:Schema:sentrymetaLast_errno:0Killed:0Query_time:0.315758Lock_
Python进阶者 Python进阶者
4个月前
Excel中这日期老是出来00:00:00,怎么用Pandas把这个去除
大家好,我是皮皮。一、前言前几天在Python白银交流群【上海新年人】问了一个Pandas数据筛选的问题。问题如下:这日期老是出来00:00:00,怎么把这个去除。二、实现过程后来【论草莓如何成为冻干莓】给了一个思路和代码如下:pd.toexcel之前把这