Commit 340f6cc9 authored by Laurent Peuch's avatar Laurent Peuch
Browse files

feat: add cubes-level.html

parent e32e5d18c947
Pipeline #65188 failed with stages
in 5 minutes and 11 seconds
<!doctype html>
<html>
<head>
<meta http-equiv="Content-type" content="text/html; charset=utf-8">
<title>Cubes Level</title>
</head>
<body>
<h1>Cubes level</h1>
<p>Cubes level are quality levels attributed to Cubicweb's Cubes, they server a series of purpose:</p>
<ul>
<li>give to the users of this cube a quality information</li>
<li>give to the developpers of this cube a clear improvement roadmap</li>
<li>gamefy a little bit the cube development for motivation</li>
</ul>
<p><i>The level is based on information stored in logilab.trig periodically scrapped by logigraph so you might see a temporary desynchronisation between the level and the reality of the cube code.</i></p>
Niveaux
<h2>Cubes levels critera</h2>
<ol>
<li>The cube doesn't implement any QA recommendation</li>
<li>We know what this cube is about
<ul>
<li>the cube has a README</li>
<li>the cube has a tox.ini</li>
</ul>
</li>
<li>The cube is usable today
<ul>
<li>the cube is using python 3 (we test this by checking if the tests are run in python 3)</li>
<li>the cube is using the cube new format</li>
<li>the cube is launching its tests with pytest</li>
</ul>
</li>
<li>There is a CI
<ul>
<li>the cube has a <i>.gitlab-ci.yaml</i></li>
</ul>
</li>
<li>Correct installation guarantee
<ul>
<li>the cube uses check-manifest</li>
</ul>
</li>
<li>The cube is able to release
<ul>
<li>the cube has deb-publish command</li>
<li>the cube has pypi-publish command</li>
</ul>
</li>
<li>Code quality
<ul>
<li>the cube uses flake8</li>
<li>the cube uses black</li>
</ul>
</li>
<li>It's documented!
<ul>
<li>The cube ships a documentation folder</li>
</ul>
</li>
<li>And the documentation is accessible!
<ul>
<li>And the documentation is available on read-the-docs (only for public projects)</li>
</ul>
</li>
<li>Cube doctor has been there
<ul>
<li>capture deprecated warnings is used</li>
<li>from-forge is used</li>
</ul>
</li>
<li>Typidy-types
<ul>
<li>The cube uses mypy</li>
</ul>
</li>
<li>Clean repository
<ul>
<li>The number of MR is equal to the number of topics</li>
</ul>
</li>
</ol>
</body>
</html>
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment