docs/review-template.html

<!DOCTYPE html>
<html lang="en" dir="ltr">
<!-- SPDX-License-Identifier: CC0-1.0 -->
<!-- SPDX-FileCopyrightText: 2022-2024 The Foundation for Public Code <info@publiccode.net>, https://standard.publiccode.net/AUTHORS -->
<head>
<meta charset="UTF-8">
<title>________ and the Standard for Public Code</title>
<style>
html, body {
font-family: Mulish;
font-size: 11pt;
}
h1, h2 {
font-weight: normal;
position: relative;
}
h1 {
margin-top: 0;
font-size: 1.5cm;
border-bottom: none;
}
h2 {
font-size: 1.5em;
}
@media print {
a {
color: #111;
text-decoration: none;
}
th {
font-weight: 600;
}
td {
padding: 6px 13px;
border: 1px solid #dfe2e5;
}
tr {
background-color: #fff;
border-top: 1px solid #c6cbd1;
}
tr:nth-child(2n) {
background-color: #f6f8fa;
}
}
</style>
</head>
<body>
<h1>________ and the Standard for Public Code version <span class="standard-version">0.8.0</span></h1>

Link to commitment to meet the Standard for Public Code:

<h2><a href="https://standard.publiccode.net/criteria/code-in-the-open.html">Code in the open</a></h2>

&#9744;<!-- &#9745; --> criterion met.

<table id="code-in-the-open" style="width:100%">
<tr><th>Meets</th><th>Requirement</th><th style="width:25%">Notes and links</th></tr>
<tr>
<td>

</td>
<td>
All source code for any software in use (unless used for fraud detection) MUST be published and publicly accessible.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
All source code for any policy in use (unless used for fraud detection) MUST be published and publicly accessible.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
The codebase MUST NOT contain sensitive information regarding users, their organization or third parties.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Any source code not currently in use (such as new versions, proposals or older versions) SHOULD be published.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Documenting which source code or policy underpins any specific interaction the general public may have with an organization is OPTIONAL.
</td>
<td>

</td>
</tr>

</table>

<h2><a href="https://standard.publiccode.net/criteria/bundle-policy-and-source-code.html">Bundle policy and source code</a></h2>

&#9744;<!-- &#9745; --> criterion met.

<table id="bundle-policy-and-source-code" style="width:100%">
<tr><th>Meets</th><th>Requirement</th><th style="width:25%">Notes and links</th></tr>
<tr>
<td>

</td>
<td>
The codebase MUST include the policy that the source code is based on.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
If a policy is based on source code, that source code MUST be included in the codebase, unless used for fraud detection.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Policy SHOULD be provided in machine-readable and unambiguous formats.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Continuous integration tests SHOULD validate that the source code and the policy are executed coherently.
</td>
<td>

</td>
</tr>

</table>

<h2><a href="https://standard.publiccode.net/criteria/make-the-codebase-reusable-and-portable.html">Make the codebase reusable and portable</a></h2>

&#9744;<!-- &#9745; --> criterion met.

<table id="make-the-codebase-reusable-and-portable" style="width:100%">
<tr><th>Meets</th><th>Requirement</th><th style="width:25%">Notes and links</th></tr>
<tr>
<td>

</td>
<td>
The codebase MUST be developed to be reusable in different contexts.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
The codebase MUST be independent from any secret, undisclosed, proprietary or non-open licensed software or services for execution and understanding.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
The codebase SHOULD be in use by multiple parties.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
The roadmap SHOULD be influenced by the needs of multiple parties.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
The development of the codebase SHOULD be a collaboration between multiple parties.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Configuration SHOULD be used to make source code adapt to context specific needs.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
The codebase SHOULD be localizable.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Source code and its documentation SHOULD NOT contain situation-specific information.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Codebase modules SHOULD be documented in such a way as to enable reuse in codebases in other contexts.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
The software SHOULD NOT require services or platforms available from only a single vendor.
</td>
<td>

</td>
</tr>

</table>

<h2><a href="https://standard.publiccode.net/criteria/welcome-contributors.html">Welcome contributors</a></h2>

&#9744;<!-- &#9745; --> criterion met.

<table id="welcome-contributors" style="width:100%">
<tr><th>Meets</th><th>Requirement</th><th style="width:25%">Notes and links</th></tr>
<tr>
<td>

</td>
<td>
The codebase MUST allow anyone to submit suggestions for changes to the codebase.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
The codebase MUST include contribution guidelines explaining what kinds of contributions are welcome and how contributors can get involved, for example in a `CONTRIBUTING` file.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
The codebase MUST document the governance of the codebase, contributions and its community, for example in a `GOVERNANCE` file.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
The contribution guidelines SHOULD document who is expected to cover the costs of reviewing contributions.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
The codebase SHOULD advertise the committed engagement of involved organizations in the development and maintenance.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
The codebase SHOULD have a publicly available roadmap.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
The codebase SHOULD publish codebase activity statistics.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Including a code of conduct for contributors in the codebase is OPTIONAL.
</td>
<td>

</td>
</tr>

</table>

<h2><a href="https://standard.publiccode.net/criteria/make-contributing-easy.html">Make contributing easy</a></h2>

&#9744;<!-- &#9745; --> criterion met.

<table id="make-contributing-easy" style="width:100%">
<tr><th>Meets</th><th>Requirement</th><th style="width:25%">Notes and links</th></tr>
<tr>
<td>

</td>
<td>
The codebase MUST have a public issue tracker that accepts suggestions from anyone.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
The documentation MUST link to both the public issue tracker and submitted codebase changes, for example in a `README` file.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
The codebase MUST have communication channels for users and developers, for example email lists.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
There MUST be a way to report security issues for responsible disclosure over a closed channel.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
The documentation MUST include instructions for how to report potentially security sensitive issues.
</td>
<td>

</td>
</tr>

</table>

<h2><a href="https://standard.publiccode.net/criteria/maintain-version-control.html">Maintain version control</a></h2>

&#9744;<!-- &#9745; --> criterion met.

<table id="maintain-version-control" style="width:100%">
<tr><th>Meets</th><th>Requirement</th><th style="width:25%">Notes and links</th></tr>
<tr>
<td>

</td>
<td>
All files in the codebase MUST be version controlled.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
All decisions MUST be documented in commit messages.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Every commit message MUST link to discussions and issues wherever possible.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
The codebase SHOULD be maintained in a distributed version control system.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Contribution guidelines SHOULD require contributors to group relevant changes in commits.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Maintainers SHOULD mark released versions of the codebase, for example using revision tags or textual labels.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Contribution guidelines SHOULD encourage file formats where the changes within the files can be easily viewed and understood in the version control system.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
It is OPTIONAL for contributors to sign their commits and provide an email address, so that future contributors are able to contact past contributors with questions about their work.
</td>
<td>

</td>
</tr>

</table>

<h2><a href="https://standard.publiccode.net/criteria/require-review-of-contributions.html">Require review of contributions</a></h2>

&#9744;<!-- &#9745; --> criterion met.

<table id="require-review-of-contributions" style="width:100%">
<tr><th>Meets</th><th>Requirement</th><th style="width:25%">Notes and links</th></tr>
<tr>
<td>

</td>
<td>
All contributions that are accepted or committed to release versions of the codebase MUST be reviewed by another contributor.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Reviews MUST include source, policy, tests and documentation.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Reviewers MUST provide feedback on all decisions to not accept a contribution.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
The review process SHOULD confirm that a contribution conforms to the standards, architecture and decisions set out in the codebase in order to pass review.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Reviews SHOULD include running both the software and the tests of the codebase.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Contributions SHOULD be reviewed by someone in a different context than the contributor.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Version control systems SHOULD NOT accept non-reviewed contributions in release versions.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Reviews SHOULD happen within two business days.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Performing reviews by multiple reviewers is OPTIONAL.
</td>
<td>

</td>
</tr>

</table>

<h2><a href="https://standard.publiccode.net/criteria/document-codebase-objectives.html">Document codebase objectives</a></h2>

&#9744;<!-- &#9745; --> criterion met.

<table id="document-codebase-objectives" style="width:100%">
<tr><th>Meets</th><th>Requirement</th><th style="width:25%">Notes and links</th></tr>
<tr>
<td>

</td>
<td>
The codebase MUST contain documentation of its objectives, like a mission and goal statement, that is understandable by developers and designers so that they can use or contribute to the codebase.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Codebase documentation SHOULD clearly describe the connections between policy objectives and codebase objectives.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Documenting the objectives of the codebase for the general public is OPTIONAL.
</td>
<td>

</td>
</tr>

</table>

<h2><a href="https://standard.publiccode.net/criteria/document-the-code.html">Document the code</a></h2>

&#9744;<!-- &#9745; --> criterion met.

<table id="document-the-code" style="width:100%">
<tr><th>Meets</th><th>Requirement</th><th style="width:25%">Notes and links</th></tr>
<tr>
<td>

</td>
<td>
All of the functionality of the codebase, policy as well as source code, MUST be described in language clearly understandable for those that understand the purpose of the codebase.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
The documentation of the codebase MUST contain a description of how to install and run the software.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
The documentation of the codebase MUST contain examples demonstrating the key functionality.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
The documentation of the codebase SHOULD contain a high level description that is clearly understandable for a wide audience of stakeholders, like the general public and journalists.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
The documentation of the codebase SHOULD contain a section describing how to install and run a standalone version of the source code, including, if necessary, a test dataset.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
The documentation of the codebase SHOULD contain examples for all functionality.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
The documentation SHOULD describe the key components or modules of the codebase and their relationships, for example as a high level architectural diagram.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
There SHOULD be continuous integration tests for the quality of the documentation.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Including examples that make users want to immediately start using the codebase in the documentation of the codebase is OPTIONAL.
</td>
<td>

</td>
</tr>

</table>

<h2><a href="https://standard.publiccode.net/criteria/use-plain-english.html">Use plain English</a></h2>

&#9744;<!-- &#9745; --> criterion met.

<table id="use-plain-english" style="width:100%">
<tr><th>Meets</th><th>Requirement</th><th style="width:25%">Notes and links</th></tr>
<tr>
<td>

</td>
<td>
The set of authoritative languages for codebase documentation MUST be documented.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
English MUST be one of the authoritative languages.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
All codebase documentation MUST be up to date in all authoritative languages.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
All source code MUST be in English, except where policy is machine interpreted as code.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
All bundled policy MUST be available, or have a summary, in all authoritative languages.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
There SHOULD be no acronyms, abbreviations, puns or legal/language/domain specific terms in the codebase without an explanation preceding it or a link to an explanation.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Documentation SHOULD aim for a lower secondary education reading level, as recommended by the <a href="https://www.w3.org/WAI/WCAG22/quickref/?showtechniques=315#reading-level">Web Content Accessibility Guidelines 2</a>.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Providing additional courtesy translations of any code, documentation or tests is OPTIONAL.
</td>
<td>

</td>
</tr>

</table>

<h2><a href="https://standard.publiccode.net/criteria/use-open-standards.html">Use open standards</a></h2>

&#9744;<!-- &#9745; --> criterion met.

<table id="use-open-standards" style="width:100%">
<tr><th>Meets</th><th>Requirement</th><th style="width:25%">Notes and links</th></tr>
<tr>
<td>

</td>
<td>
For features of the codebase that facilitate the exchange of data the codebase MUST use an open standard that meets the <a href="https://opensource.org/osr">Open Source Initiative Open Standard Requirements</a>.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Any non-open standards used MUST be recorded clearly as such in the documentation.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Any standard chosen for use within the codebase MUST be listed in the documentation with a link to where it is available.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Any non-open standards chosen for use within the codebase MUST NOT hinder collaboration and reuse.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
If no existing open standard is available, effort SHOULD be put into developing one.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Open standards that are machine testable SHOULD be preferred over open standards that are not.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Non-open standards that are machine testable SHOULD be preferred over non-open standards that are not.
</td>
<td>

</td>
</tr>

</table>

<h2><a href="https://standard.publiccode.net/criteria/use-continuous-integration.html">Use continuous integration</a></h2>

&#9744;<!-- &#9745; --> criterion met.

<table id="use-continuous-integration" style="width:100%">
<tr><th>Meets</th><th>Requirement</th><th style="width:25%">Notes and links</th></tr>
<tr>
<td>

</td>
<td>
All functionality in the source code MUST have automated tests.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Contributions MUST pass all automated tests before they are admitted into the codebase.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
The codebase MUST have guidelines explaining how to structure contributions.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
The codebase MUST have active contributors who can review contributions.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Automated test results for contributions SHOULD be public.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
The codebase guidelines SHOULD state that each contribution should focus on a single issue.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Source code test and documentation coverage SHOULD be monitored.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Testing policy and documentation for consistency with the source and vice versa is OPTIONAL.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Testing policy and documentation for style and broken links is OPTIONAL.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Testing the software by using examples in the documentation is OPTIONAL.
</td>
<td>

</td>
</tr>

</table>

<h2><a href="https://standard.publiccode.net/criteria/publish-with-an-open-license.html">Publish with an open license</a></h2>

&#9744;<!-- &#9745; --> criterion met.

<table id="publish-with-an-open-license" style="width:100%">
<tr><th>Meets</th><th>Requirement</th><th style="width:25%">Notes and links</th></tr>
<tr>
<td>

</td>
<td>
All source code and documentation MUST be licensed such that it may be freely reusable, changeable and redistributable.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Software source code MUST be licensed under an <a href="https://spdx.org/licenses/">OSI-approved or FSF Free/Libre license</a>.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
All source code MUST be published with a license file.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Contributors MUST NOT be required to transfer copyright of their contributions to the codebase.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
All source code files in the codebase SHOULD include a copyright notice and a license header that are machine-readable.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Having multiple licenses for different types of source code and documentation is OPTIONAL.
</td>
<td>

</td>
</tr>

</table>

<h2><a href="https://standard.publiccode.net/criteria/make-the-codebase-findable.html">Make the codebase findable</a></h2>

&#9744;<!-- &#9745; --> criterion met.

<table id="make-the-codebase-findable" style="width:100%">
<tr><th>Meets</th><th>Requirement</th><th style="width:25%">Notes and links</th></tr>
<tr>
<td>

</td>
<td>
The name of the codebase SHOULD be descriptive and free from acronyms, abbreviations, puns or organizational branding.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
The codebase SHOULD have a short description that helps someone understand what the codebase is for or what it does.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Maintainers SHOULD submit the codebase to relevant software catalogs.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
The codebase SHOULD have a website which describes the problem the codebase solves using the preferred jargon of different potential users of the codebase (including technologists, policy experts and managers).
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
The codebase SHOULD be findable using a search engine by codebase name.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
The codebase SHOULD be findable using a search engine by describing the problem it solves in natural language.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
The codebase SHOULD have a unique and persistent identifier where the entry mentions the major contributors, repository location and website.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
The codebase SHOULD include a machine-readable metadata description, for example in a <a href="https://github.com/publiccodeyml/publiccode.yml">publiccode.yml</a> file.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
A dedicated domain name for the codebase is OPTIONAL.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Regular presentations at conferences by the community are OPTIONAL.
</td>
<td>

</td>
</tr>

</table>

<h2><a href="https://standard.publiccode.net/criteria/use-a-coherent-style.html">Use a coherent style</a></h2>

&#9744;<!-- &#9745; --> criterion met.

<table id="use-a-coherent-style" style="width:100%">
<tr><th>Meets</th><th>Requirement</th><th style="width:25%">Notes and links</th></tr>
<tr>
<td>

</td>
<td>
The codebase MUST use a coding or writing style guide, either the codebase community's own or an existing one referred to in the codebase.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Contributions SHOULD pass automated tests on style.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
The style guide SHOULD include expectations for inline comments and documentation for non-trivial sections.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Including expectations for <a href="https://standard.publiccode.net/criteria/use-plain-english.html">understandable English</a> in the style guide is OPTIONAL.
</td>
<td>

</td>
</tr>

</table>

<h2><a href="https://standard.publiccode.net/criteria/document-codebase-maturity.html">Document codebase maturity</a></h2>

&#9744;<!-- &#9745; --> criterion met.

<table id="document-codebase-maturity" style="width:100%">
<tr><th>Meets</th><th>Requirement</th><th style="width:25%">Notes and links</th></tr>
<tr>
<td>

</td>
<td>
The codebase MUST be versioned.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
The codebase MUST prominently document whether or not there are versions of the codebase that are ready to use.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
Codebase versions that are ready to use MUST only depend on versions of other codebases that are also ready to use.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
The codebase SHOULD contain a log of changes from version to version, for example in the `CHANGELOG`.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
The method for assigning version identifiers SHOULD be documented.
</td>
<td>

</td>
</tr>

<tr>
<td>

</td>
<td>
It is OPTIONAL to use semantic versioning.
</td>
<td>

</td>
</tr>

</table>
</body>
</html>