The Standard for Public Code's compliance to the criteria and requirements of the Standard for Public Code version 0.7.1

The Standard for Public Code is not a codebase created in the context of a policy mandate, thus some criteria do not apply directly. Link to commitment to meet the Standard for Public Code: [CONTRIBUTING.md](../CONTRIBUTING.md#1-make-your-changes)

Code in the open

☑ criterion met.
MeetsRequirementNotes and links
N/A All source code for any software in use (unless used for fraud detection) MUST be published and publicly accessible. GitHub repository, no official policy at this time
N/A All source code for any policy in use (unless used for fraud detection) MUST be published and publicly accessible. GitHub repository, not software
Ok The codebase MUST NOT contain sensitive information regarding users, their organization or third parties.
Ok Any source code not currently in use (such as new versions, proposals or older versions) SHOULD be published. GitHub releases
N/A Documenting which source code or policy underpins any specific interaction the general public may have with an organization is OPTIONAL.

Bundle policy and source code

☑ criterion met.
MeetsRequirementNotes and links
N/A The codebase MUST include the policy that the source code is based on.
N/A If a policy is based on source code, that source code MUST be included in the codebase, unless used for fraud detection.
N/A Policy SHOULD be provided in machine-readable and unambiguous formats.
N/A Continuous integration tests SHOULD validate that the source code and the policy are executed coherently.

Create reusable and portable code

☐ criterion met.
MeetsRequirementNotes and links
Ok The codebase MUST be developed to be reusable in different contexts.
Ok The codebase MUST be independent from any secret, undisclosed, proprietary or non-open licensed software or services for execution and understanding.
Ok The codebase SHOULD be in use by multiple parties. Signalen, OpenZaak, Algoritmeregister, Standard for Public Code
Ok The roadmap SHOULD be influenced by the needs of multiple parties. Community calls influenced initial roadmap
The development of the codebase SHOULD be a collaboration between multiple parties.
N/A Configuration SHOULD be used to make source code adapt to context specific needs.
Ok The codebase SHOULD be localizable.
Ok Source code and its documentation SHOULD NOT contain situation-specific information.
N/A Codebase modules SHOULD be documented in such a way as to enable reuse in codebases in other contexts.
Ok The software SHOULD NOT require services or platforms available from only a single vendor.

Welcome contributors

☑ criterion met.
MeetsRequirementNotes and links
Ok The codebase MUST allow anyone to submit suggestions for changes to the codebase.
Ok 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. CONTRIBUTING
Ok The codebase MUST document the governance of the codebase, contributions and its community, for example in a `GOVERNANCE` file. GOVERNANCE
Ok The contribution guidelines SHOULD document who is expected to cover the costs of reviewing contributions. In CONTRIBUTING
Ok The codebase SHOULD advertise the committed engagement of involved organizations in the development and maintenance.
Ok The codebase SHOULD have a publicly available roadmap. Roadmap
Ok The codebase SHOULD publish codebase activity statistics. GitHub Pulse
Ok Including a code of conduct for contributors in the codebase is OPTIONAL. CODE OF CONDUCT

Make contributing easy

☑ criterion met.
MeetsRequirementNotes and links
Ok The codebase MUST have a public issue tracker that accepts suggestions from anyone. GitHub Issues
Ok The documentation MUST link to both the public issue tracker and submitted codebase changes, for example in a `README` file. Via GitHub
Ok The codebase MUST have communication channels for users and developers, for example email lists. Mailing list
N/A There MUST be a way to report security issues for responsible disclosure over a closed channel.
N/A The documentation MUST include instructions for how to report potentially security sensitive issues.

Maintain version control

☑ criterion met.
MeetsRequirementNotes and links
Ok All files in the codebase MUST be version controlled.
Ok All decisions MUST be documented in commit messages.
Ok Every commit message MUST link to discussions and issues wherever possible.
Ok The codebase SHOULD be maintained in a distributed version control system. git
Ok Contribution guidelines SHOULD require contributors to group relevant changes in commits.
Ok Maintainers SHOULD mark released versions of the codebase, for example using revision tags or textual labels. GitHub releases
Ok Contribution guidelines SHOULD encourage file formats where the changes within the files can be easily viewed and understood in the version control system.
Ok 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.

Require review of contributions

☑ criterion met.
MeetsRequirementNotes and links
Ok All contributions that are accepted or committed to release versions of the codebase MUST be reviewed by another contributor.
Ok Reviews MUST include source, policy, tests and documentation. policy does not apply
Ok Reviewers MUST provide feedback on all decisions to not accept a contribution.
Ok 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.
Ok Reviews SHOULD include running both the software and the tests of the codebase. GitHub Actions
Ok Contributions SHOULD be reviewed by someone in a different context than the contributor. Usually in the same context, rarely get reviews from other contexts, currently no other contexts regularly available
Ok Version control systems SHOULD NOT accept non-reviewed contributions in release versions. the `main` branch is "protected"
Ok Reviews SHOULD happen within two business days. very few exceptions
Ok Performing reviews by multiple reviewers is OPTIONAL. for larger contributions

Document codebase objectives

☑ criterion met.
MeetsRequirementNotes and links
Ok 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.
N/A Codebase documentation SHOULD clearly describe the connections between policy objectives and codebase objectives.
Ok Documenting the objectives of the codebase for the general public is OPTIONAL.

Document the code

☑ criterion met.
MeetsRequirementNotes and links
Ok 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.
N/A The documentation of the codebase MUST contain a description of how to install and run the software.
N/A The documentation of the codebase MUST contain examples demonstrating the key functionality.
Ok 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.
N/A 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.
N/A The documentation of the codebase SHOULD contain examples for all functionality.
N/A The documentation SHOULD describe the key components or modules of the codebase and their relationships, for example as a high level architectural diagram.
Ok There SHOULD be continuous integration tests for the quality of the documentation. GitHub Actions
Including examples that make users want to immediately start using the codebase in the documentation of the codebase is OPTIONAL. We're not linking to examples

Use plain English

☑ criterion met.
MeetsRequirementNotes and links
Ok The set of authoritative languages for codebase documentation MUST be documented.
Ok English MUST be one of the authoritative languages.
N/A All codebase documentation MUST be up to date in all authoritative languages.
Ok All source code MUST be in English, except where policy is machine interpreted as code.
N/A All bundled policy MUST be available, or have a summary, in all authoritative languages.
Ok 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.
Ok Documentation SHOULD aim for a lower secondary education reading level, as recommended by the Web Content Accessibility Guidelines 2.
Providing additional courtesy translations of any code, documentation or tests is OPTIONAL. We have Community translations

Use open standards

☑ criterion met.
MeetsRequirementNotes and links
N/A For features of the codebase that facilitate the exchange of data the codebase MUST use an open standard that meets the Open Source Initiative Open Standard Requirements.
N/A Any non-open standards used MUST be recorded clearly as such in the documentation.
Ok Any standard chosen for use within the codebase MUST be listed in the documentation with a link to where it is available. CONTRIBUTING
N/A Any non-open standards chosen for use within the codebase MUST NOT hinder collaboration and reuse.
N/A If no existing open standard is available, effort SHOULD be put into developing one.
N/A Open standards that are machine testable SHOULD be preferred over open standards that are not.
N/A Non-open standards that are machine testable SHOULD be preferred over non-open standards that are not.

Use continuous integration

☑ criterion met.
MeetsRequirementNotes and links
Ok All functionality in the source code MUST have automated tests.
Ok Contributions MUST pass all automated tests before they are admitted into the codebase.
Ok The codebase MUST have guidelines explaining how to structure contributions.
Ok The codebase MUST have active contributors who can review contributions.
Ok Automated test results for contributions SHOULD be public.
Ok The codebase guidelines SHOULD state that each contribution should focus on a single issue.
N/A Source code test and documentation coverage SHOULD be monitored.
N/A Testing policy and documentation for consistency with the source and vice versa is OPTIONAL.
Ok Testing policy and documentation for style and broken links is OPTIONAL.
N/A Testing the software by using examples in the documentation is OPTIONAL.

Publish with an open license

☑ criterion met.
MeetsRequirementNotes and links
Ok All source code and documentation MUST be licensed such that it may be freely reusable, changeable and redistributable. CC 0
Ok Software source code MUST be licensed under an OSI-approved or FSF Free/Libre license. CC 0
Ok All source code MUST be published with a license file.
Ok Contributors MUST NOT be required to transfer copyright of their contributions to the codebase.
Ok All source code files in the codebase SHOULD include a copyright notice and a license header that are machine-readable.
Ok Having multiple licenses for different types of source code and documentation is OPTIONAL. CC 0

Make the codebase findable

☑ criterion met.
MeetsRequirementNotes and links
Ok The name of the codebase SHOULD be descriptive and free from acronyms, abbreviations, puns or organizational branding.
Ok The codebase SHOULD have a short description that helps someone understand what the codebase is for or what it does.
Ok Maintainers SHOULD submit the codebase to relevant software catalogs. In the DPG registry
Ok 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).
Ok The codebase SHOULD be findable using a search engine by codebase name.
Ok The codebase SHOULD be findable using a search engine by describing the problem it solves in natural language.
Ok The codebase SHOULD have a unique and persistent identifier where the entry mentions the major contributors, repository location and website. Q68006929 on Wikidata
Ok The codebase SHOULD include a machine-readable metadata description, for example in a publiccode.yml file. publiccode.yml
Ok A dedicated domain name for the codebase is OPTIONAL.
Ok Regular presentations at conferences by the community are OPTIONAL.

Use a coherent style

☑ criterion met.
MeetsRequirementNotes and links
Ok 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.
Ok Contributions SHOULD pass automated tests on style.
N/A The style guide SHOULD include expectations for inline comments and documentation for non-trivial sections. maybe some of the Jekyll could apply
Ok Including expectations for understandable English in the style guide is OPTIONAL.

Document codebase maturity

☑ criterion met.
MeetsRequirementNotes and links
Ok The codebase MUST be versioned.
Ok The codebase MUST prominently document whether or not there are versions of the codebase that are ready to use.
Ok Codebase versions that are ready to use MUST only depend on versions of other codebases that are also ready to use.
Ok The codebase SHOULD contain a log of changes from version to version, for example in the `CHANGELOG`. CHANGELOG
Ok The method for assigning version identifiers SHOULD be documented.
Ok It is OPTIONAL to use semantic versioning.