作者huei90 (huei90)
看板Soft_Job
标题[心得] 我在 GitHub 上学习 Open Source-徽章篇
时间Tue Jan 5 11:26:08 2016
哈罗大家好,新年新希望,系列文短篇第一炮《徽章篇》
在 Open Source 世界里你常常会看到一个词「Badge」,好吧,我承认我不知道应该用什麽词代表,容许我先在这里翻译成「徽章」。但我想不是大家都懂这徽章指的是什麽。已经在开发 Open Source 的人应该对这徽章不陌生了,欢迎纠正以及补充资料!至於专案什麽时候使用徽章?他如何帮助你的 Open Source 专案开发呢?让我来为各位做个简单的介绍。废话少说,先来看看什麽是徽章
http://i.imgur.com/PEZpnpb.png
[徽章介绍]
为何我会推荐大家使用徽章呢?使用徽章有几种红绿灯通用颜色-红色、黄色、绿色。如果专案内有红色的徽章,马上反应就会觉得这专案是不是有什麽问题,反之徽章全都是绿色的时候,是不是就有安心的感觉呢。通常徽章用来回报专案目前的状态如:测试顺不顺利、Issue 状态、Code
品质、文件是否齐全、专案下载量、专案版本等等。设定上不会很困难,一旦第一次设定好後(依据服务要求),基本上往後就是自动化你也不需要再操心,任何一个动作都会直接影响到专案徽章状态。不要小看这小小的状态列,它能即时把专案的详情告知使用者,他们不必多做猜测,你也不用多花心思检查,因为徽章都会帮你处理好一切。
以我自身使用的例子,我常使用 [Travis CI] [CodeClimate] [Coverage] [David] [Gitter Chat] [Awesome Badge] [MORE]
以下简单介绍 ▼
[Travis CI]
如果你的专案是 Open Source 开放的,Travis 提供一个免费的 CI 环境,让你每 Commit 一次执行你设定好的 Bash,不过大家一般都还是拿来跑测试结果。Travis CI 支援各种程式语言,你只要在专案中产生一个文件 .travis.yml,设定好即可。以 A-V 的范例,跑完测试後,会执行 Coverage 再推上 Coveralls。
网站:
https://travis-ci.org/
文件:
https://docs.travis-ci.com/
范例:
https://travis-ci.org/huei90/angular-validation
推荐:必学!必用!简单上手。
[CodeClimate]
就如网站上说的,CodeClimate 会自动化帮你的专案 Code Review,经过自动化 Review,他会为你的专案打 GPA 分数。使用上非常简单,登入後只要把专案名称输入进去即可。分数最高4分,其实除了自我感觉良好外,也给其他人马上知道你的专案的分数。
有些档案不需要被打分,这时候就要用到 .codeclimate.yml 档案了,详情请看文件。
网站:
https://codeclimate.com
文件:
https://docs.codeclimate.com/
范例:
https://codeclimate.com/github/huei90/angular-validation
推荐:改到分数高在放上去比较可口。
[Coverage]
其实我之前不懂这是什麽,只听说 Test Coverage 可以自动帮你检查测试涵盖率,其实听起来超威的。它拥有特殊的演算法(istanbul),会自动检查专案和测试的程式码做复杂的比对,最後给上测试涵盖率 Coverage 成绩。
就如我之前常常提到的测试,一旦你程式写完後,测试的部分也完成了,但其实自己也不知道漏了哪些部份没有写上测试,这时候 Test Coverage 就能帮上你忙了!
网站:
https://coveralls.io
文件:
https://coveralls.zendesk.com/hc/en-us
范例:
https://coveralls.io/github/huei90/angular-validation
推荐:我搞了一阵子才理解 Coverage 的运作,不过一旦学会,未来就没什麽问题了。
[David]
如果你有使用 npm 的话,这个徽章工具非常推荐,它会自动帮你检查 package.json 中的 Dependencies 和 devDependencies 的版本号,并亮红灯提醒你是时候更新了。使用越多的套件,你不可能一个一个去检查版本号,这时候大卫先生绝对帮得上忙!
网站:
https://david-dm.org
文件:无
范例:
https://david-dm.org/huei90/angular-validation#info=devDependencies
推荐:一目了然,没什麽难的
[Gitter Chat]
之前文章我有简单介绍到 Gitter 这个 Repo 聊天室,这个徽章其实只是提供一个快速连结到聊天室,仅此。(有时候会觉得提供徽章比提供一长串 URL 连接乾净许多)
网站:
https://gitter.im
文件:无
范例:无
推荐:根据专案需求
[Awesome Badge]
Awesome 系列在 GitHub 上潮了一整子,你今天 Awesome 了吗?後来 Awesome 的作者提供了 Awesome 徽章,算是对 Awesome-XX 专案的一个认可。其实 Awesome 的作者很严格,并不是取名为 Awesome-XX 都能被列在 Awesome list 中-专案介绍、内容、成熟度等等的条件加总起来才有机会实质获得 Awesome 的徽章。
网站:
https://github.com/sindresorhus/awesome
推荐:有写 Awesome 文的才需要
[MORE]
这说也说不完,以下几个推荐的连结,你可以找到各种类型的徽章,不过有些徽章使用的服务是要付费的喔。
1.
https://github.com/boennemann/badges
2.
http://shields.io/
每个专案都有属於自己的徽章,
去吧 去找寻茫茫之中属於你专案的徽章 吧~
[END]
希望这篇介绍对於想要进入 Open Source 世界的朋友们有所帮助,一旦你的专案逐渐壮大起来,放上徽章也算是对它的一个肯定喔!(自己的专案自己救)
这次要来工商一下,一直 po 在 PTT 实在不好意思,我在自己的 GitHub 上开了个 blog 的空间,对於我分享的文章有兴趣的朋友,我来讨星星和眼睛^^咯,眼睛了才能持续追踪新的文章喔,嘿嘿呵哈嘿呵呵哈哈哈哈 <
https://github.com/huei90/blog 。
另外,开了一个 Issue,欢迎大家提供意见。
https://github.com/huei90/blog/issues/1
结束,句点。
--
※ 发信站: 批踢踢实业坊(ptt.cc), 来自: 220.130.162.20
※ 文章网址: https://webptt.com/cn.aspx?n=bbs/Soft_Job/M.1451964409.A.26C.html
1F:推 obamina48: 推 01/05 11:44
2F:推 y2468101216: 推啊 01/05 11:48
3F:推 rodion: 推 已加星星&眼睛 XD 01/05 11:53
4F:推 zerofinal: 推~ 01/05 12:26
5F:推 joe791023: 推 01/05 12:56
6F:推 sullivan1982: 感谢分享 01/05 13:23
7F:推 x013x: 推 01/05 13:39
8F:推 BlazarArc: 推 01/05 14:03
9F:推 johnny94: 这篇超实用! 01/05 14:58
10F:推 chrome: 推 01/05 16:11
11F:推 bcew: 感谢分享~ 01/05 17:29
12F:推 gn00273680: 推 01/05 18:16
13F:推 sillyjerry: 感谢分享 01/05 18:41
14F:推 james732: 推 01/05 18:55
15F:推 ntddt: 推 推广 01/05 19:58
16F:推 musicmuj: 推 01/05 21:20
17F:推 chrome: 推 01/05 21:43
18F:推 jmarr: 推 01/05 22:00
19F:推 simonjoker: 原PO一定有玩炉石XDDD 01/05 22:18
可惜没有耶ˊ_>ˋ
※ 编辑: huei90 (1.160.81.126), 01/05/2016 22:37:42
20F:推 jeromeshih: 推 01/05 23:36
21F:推 darish314: 推 谢谢教学 01/05 23:44
22F:推 ice791020: 推 专业好文 01/06 00:56
23F:→ viper9709: 推~感谢分享 01/06 23:53
24F:推 zx1986: cool 01/07 07:34
25F:推 hero0123: 感谢分享~ 07/08 08:39