2019-04-16 20:55:15 +02:00
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="utf-8">
|
2019-04-18 13:45:17 +02:00
|
|
|
<link rel="stylesheet" href="tacit-css.min.css" />
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
2019-04-16 20:55:15 +02:00
|
|
|
<title>Hits-of-Code Badges</title>
|
|
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
|
2019-04-19 19:13:43 +02:00
|
|
|
<section>
|
2019-04-16 20:55:15 +02:00
|
|
|
<h1>Hits-of-Code Badges</h1>
|
2019-04-19 19:13:43 +02:00
|
|
|
</section>
|
2019-04-16 20:55:15 +02:00
|
|
|
|
2019-04-19 19:13:43 +02:00
|
|
|
<section>
|
2019-04-16 20:55:15 +02:00
|
|
|
<div>
|
2019-04-17 21:53:43 +02:00
|
|
|
<p>
|
2019-04-16 20:55:15 +02:00
|
|
|
This API offers badges for the Hits-of-Code metric for your repositories. This metric was proposed by
|
|
|
|
|
<a href="https://www.yegor256.com/">Yegor Bugayenko</a> as an
|
|
|
|
|
<a href="https://www.yegor256.com/2014/11/14/hits-of-code.html">alternative to Lines-of-Code</a>.
|
2019-04-17 21:53:43 +02:00
|
|
|
</p>
|
2019-04-16 20:55:15 +02:00
|
|
|
|
2019-04-17 21:53:43 +02:00
|
|
|
<p>
|
|
|
|
|
Instead of counting the number of existing lines in a codebase, the number of modified lines is counted. That way, the
|
2019-04-16 20:55:15 +02:00
|
|
|
metric can only grow and never shrink. While this metric still cannot give any information about the code quality, it
|
|
|
|
|
gives an overview about the amount of work put into a codebase.
|
2019-04-17 21:53:43 +02:00
|
|
|
</p>
|
2019-04-16 20:55:15 +02:00
|
|
|
|
2019-04-17 20:48:47 +02:00
|
|
|
<p>
|
2019-04-16 20:55:15 +02:00
|
|
|
There is a <a href="https://github.com/yegor256/hoc/">command-line tool</a> to calculate the HoC of a repository, but
|
|
|
|
|
some people might want a nice badge to put in their README, that's why I implemented this API. Currently the API can be
|
|
|
|
|
used for GitHub, GitLab and Bitbucket repositories. Just put the following code in your README:
|
2019-04-17 21:53:43 +02:00
|
|
|
</p>
|
2019-04-16 20:55:15 +02:00
|
|
|
|
|
|
|
|
<pre>
|
2019-04-18 14:33:29 +02:00
|
|
|
[](https://hitsofcode.com/<service>/<user>/<repo>)
|
2019-04-16 20:55:15 +02:00
|
|
|
</pre>
|
|
|
|
|
|
2019-04-17 20:48:47 +02:00
|
|
|
<p>
|
2019-04-16 20:55:15 +02:00
|
|
|
where <code><service></code> is one of <code>github</code>, <code>gitlab</code> or <code>bitbucket</code>. So the
|
|
|
|
|
following Markdown
|
2019-04-17 21:53:43 +02:00
|
|
|
</p>
|
2019-04-16 20:55:15 +02:00
|
|
|
|
|
|
|
|
<pre>
|
2019-04-19 17:59:39 +02:00
|
|
|
[](https://hitsofcode.com/view/github/vbrandl/hoc)
|
2019-04-16 20:55:15 +02:00
|
|
|
</pre>
|
|
|
|
|
|
2019-04-17 20:48:47 +02:00
|
|
|
<p>
|
2019-04-16 20:55:15 +02:00
|
|
|
would render this badge:
|
2019-04-17 21:53:43 +02:00
|
|
|
</p>
|
2019-04-16 20:55:15 +02:00
|
|
|
|
|
|
|
|
<pre>
|
2019-04-19 17:59:39 +02:00
|
|
|
<a href="https://hitsofcode.com/view/github/vbrandl/hoc"><img src="https://hitsofcode.com/github/vbrandl/hoc" /></a>
|
2019-04-16 20:55:15 +02:00
|
|
|
</pre>
|
|
|
|
|
</div>
|
|
|
|
|
|
2019-04-19 16:00:30 +02:00
|
|
|
<h2>Colors</h2>
|
|
|
|
|
|
|
|
|
|
<div>
|
|
|
|
|
<p>
|
|
|
|
|
You can generate badges with custom colors via the <code>color</code> query parameter. The following predefined colors
|
|
|
|
|
are supported:
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<pre>
|
|
|
|
|
|
|
|
|
|
<img src="/badge?color=brightgreen" />
|
|
|
|
|
<img src="/badge?color=green" />
|
|
|
|
|
<img src="/badge?color=yellowgreen" />
|
|
|
|
|
<img src="/badge?color=yellow" />
|
|
|
|
|
<img src="/badge?color=orange" />
|
|
|
|
|
<img src="/badge?color=red" />
|
|
|
|
|
<img src="/badge?color=blue" />
|
|
|
|
|
<img src="/badge?color=lightgrey" />
|
|
|
|
|
|
|
|
|
|
<img src="/badge?color=success" />
|
|
|
|
|
<img src="/badge?color=important" />
|
|
|
|
|
<img src="/badge?color=critical" />
|
|
|
|
|
<img src="/badge?color=informational" />
|
|
|
|
|
<img src="/badge?color=inactive" />
|
|
|
|
|
|
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
You can also pass HTML color codes:
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<pre>
|
|
|
|
|
<img src="/badge?color=ff69b4" /> <img src="/badge?color=9cf" />
|
|
|
|
|
</pre>
|
|
|
|
|
</div>
|
|
|
|
|
|
2019-04-16 20:55:15 +02:00
|
|
|
<h2>Source Code</h2>
|
|
|
|
|
|
|
|
|
|
<div>
|
|
|
|
|
The whole service is licensed under the <a href="https://opensource.org/licenses/MIT">MIT license</a> and the source
|
|
|
|
|
code <a href="https://github.com/vbrandl/hoc">can be found on GitHub</a>. Feature proposals or pull requests are
|
|
|
|
|
welcome.
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h2>Contact</h2>
|
|
|
|
|
|
|
|
|
|
<div>
|
|
|
|
|
You can reach me via mail: <a href="mailto:mail+hoc@vbrandl.net">mail+hoc@vbrandl.net</a> preferably using
|
|
|
|
|
my <a href="https://mirror.oldsql.cc/key.asc">GPG key</a>
|
2019-04-17 21:55:46 +02:00
|
|
|
(<a href="http://pool.sks-keyservers.net/pks/lookup?op=get&search=0x1FFE431282F4B8CC0A7579167FB009175885FC76">from a
|
2019-04-16 20:55:15 +02:00
|
|
|
keyserver</a>), or by using any other UID from my key.
|
|
|
|
|
</div>
|
2019-04-19 19:13:43 +02:00
|
|
|
</section>
|
2019-04-16 20:55:15 +02:00
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
