Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/alexfernandez/package-quality

Measurements of quality for packages, especially for npm
https://github.com/alexfernandez/package-quality

Last synced: about 2 months ago
JSON representation

Measurements of quality for packages, especially for npm

Awesome Lists containing this project

README 

        
[![Package quality](https://packagequality.com/shield/package-quality.svg)](https://packagequality.com/#?package=package-quality)

[![Build Status](https://secure.travis-ci.org/alexfernandez/package-quality.svg)](http://travis-ci.org/alexfernandez/package-quality)



[![Package quality](https://packagequality.com/badge/package-quality.png)](https://packagequality.com/#?package=package-quality)



# package-quality



Measurements of quality for packages, initially for npm.



## Add Your Badge



To show the quality of your npm package, just add one of these images to your GitHub README:



```

[![Package quality](https://packagequality.com/shield/yourpackage.svg)](https://packagequality.com/#?package=yourpackage)

[![Package quality](https://packagequality.com/badge/yourpackage.png)](https://packagequality.com/#?package=yourpackage)

```



Or, in HTML markup:



```





```



replacing `yourpackage` with (surprise!) the name of your package.

You can choose between badge or mini-badge; the latter is courtesy of [shields.io](https://shields.io).



## Measuring Quality



Any objective measurements of quality are going to be flawed one way or another.

`package-quality` only attempts to give some indications about quality,

not be an absolute rating on which to bet your farm.

If you don't agree with our ratings, please [help us improve them](https://github.com/alexfernandez/package-quality/pulls)!



### Algorithm



The following factors are considered when calculating the quality of a package:

  - Versions quality (v): the more versions a package has, the more quality it is. We calculate v as ```v=1-1/total_number_of_versions```

  - Downloads quality (d): the more downloads a package has, the more quality is it. We calculate d as ```d=1-1/number_of_downloads_last_year```

  - Repo quality (r): if the package has no repo, the value of r is zero. Right now (there is an issue open to fix this), if the package does not have repo on Github, it's given ```r=0```. For those packages with a repo on Github, r is calculated considering these three factors:

    - Total factor (rt), calculated as ```rt=1-1/total_number_of_issues```

    - Open factor (ro): we consider "healthy" to have a 20% of open issues in your repo (20% of the total number of issues). Those packages with 20% or less open issues will have ```ro=1```. For those with more than 20%, ```ro=1.2-open_issues/total_number_of_issues```

    - Long open factor (rlo): we consider long open issues those who have been open more that 1 year and are still open today. This factor is calculated as ```rlo=1-long_open_issues/total_number_of_issues```. If a package has no open issues, then ```rlo=1```.



The repo quality r is calculated as the average of rt, ro and rlo: ```r=(rt+ro+rlo)/3```.



The overall quality of a package is ```q=v*d*r```.



### How to Understand Star Ratings



[![By xkcd](http://imgs.xkcd.com/comics/star_ratings.png)](http://xkcd.com/1098/)



Just joking.

New packages will always appear with low stars, until they get enough momentum.

Also, packages that "just work" and get no issues will be underrated by our system.



### Other Package Managers



Right now the quality is computed only for npm packages.

But it is trivial to extend the ratings to other package managers,

since there are only external measurements from GitHub and npm:

we don't even look at the code.



If you want to extend package-quality to a new package manager,

you just need:



* a complete list of packages,

* and some way to get the downloads per year.



[Let us know](mailto:[email protected]) and we will set up a new subdomain.



## Help Wanted



The following areas are a work in progress:



* Improve the existing ratings.

* Take other parameters into account, such as a working or broken Travis-CI build.

* Extend to other package managers (see above).

* Just let us know what you don't like about our project.



[Just send mail](mailto:[email protected]) or, even better, a pull request.



## License (The MIT License)



Copyright (c) 2014-2015 Alex Fernández ,

[Diego Lafuente](https://github.com/tufosa),

Sergio García Mondaray 

and [contributors](https://github.com/alexfernandez/package-quality/graphs/contributors).



Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:



The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.



THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.