ITエンジニア/デザイナ向けにオープンソースを毎日紹介

オープンソース・ソフトウェアの楽しさはフォークしてもらうところにあると言えるでしょう。ただ漫然と作っていても駄目で、フォークしてもらいやすいように作らないといけないでしょう。

そのためのチェックを行ってくれるのがforkabilityです。リポジトリのフォークしやすさをチェックしてくれるソフトウェアです。

forkabilityの使い方

forkabilityはGitHubに対応していますので、ユーザ名/リポジトリ名 を引数として渡すだけです。そうすると結果をMarkdownで出力してくれます。

$ forkability moongift/NCMBGoogleAuthJS
# Forkability found 3 recommended features, and has 5 suggestions

# Features (3)
✓ License document
✓ .gitignore file
✓ All open issues have been acknowledged

---

# Suggestions (5)
! Contributing document
! Readme document
! Changelog document
! Test suite
! No tags: Before releasing a new version, create a tag to represent the code at the point of that release.

---

# Forkability Badge (failure)
## Just the SVG: 
https://img.shields.io/badge/forkable-no-red.svg
## Markdown: 
[![This repository's forkability could be improved](https://img.shields.io/badge/forkable-no-red.svg)](https://basicallydan.github.io/forkability/?u=moongift&r=NCMBGoogleAuthJS)
## HTML: 
<a href="https://basicallydan.github.io/forkability/?u=moongift&r=NCMBGoogleAuthJS"><img alt="This repository's forkability could be improved" src="https://img.shields.io/badge/forkable-no-red.svg"/></a>

READMEやCHANGELOG、CONTRIBUTINGといったドキュメントが足りないといったことであったり、テストやタグなども必要であるといった注意が出ています。

$ forkability moongift/ncmb-ruby-client
# Forkability found 4 recommended features, and has 5 suggestions

# Features (4)
✓ Readme document
✓ License document
✓ .gitignore file
✓ Test suite

---

# Suggestions (5)
! Contributing document
! Changelog document
! Uncommented issue: Comment on the issue to indicate acknowledgement
├── supported below ruby 2.1 implementing to_h: https://github.com/moongift/ncmb-ruby-client/pull/16
! Untouched issue: Comment or label the issue to indicate acknowledgement
├── supported below ruby 2.1 implementing to_h: https://github.com/moongift/ncmb-ruby-client/pull/16
! No tags: Before releasing a new version, create a tag to represent the code at the point of that release.

---

# Forkability Badge (failure)
## Just the SVG: 
https://img.shields.io/badge/forkable-no-red.svg
## Markdown: 
[![This repository's forkability could be improved](https://img.shields.io/badge/forkable-no-red.svg)](https://basicallydan.github.io/forkability/?u=moongift&r=ncmb-ruby-client)
## HTML: 
<a href="https://basicallydan.github.io/forkability/?u=moongift&r=ncmb-ruby-client"><img alt="This repository's forkability could be improved" src="https://img.shields.io/badge/forkable-no-red.svg"/></a>

対応していないIssueがある場合なども注意が出ます。指摘された問題点を解決することで、フォークされやすいプロジェクトができあがることでしょう。

forkabilityはnode/JavaScript製、MIT Licenseのオープンソース・ソフトウェアです。

basicallydan/forkability

 

MOONGIFTの関連記事

コメント

  • MOONGIFTプレミアム
  • Mobile Touch