Open-source compliance¶
The project's funder sets open-source requirements for each quarter. This
page lists them, their status and where each one is met. Each requirement
is tracked as an issue with the compliance label
(all compliance issues).
Status values:
- Done: met, with the evidence linked.
- In progress: work has started.
- Planned: not started.
This page is updated in the pull request that changes a requirement's status.
Q1: Foundation and licensing¶
| Requirement | Status | Where it is met | Issue |
|---|---|---|---|
| Open-source licence | Done | LICENSE (Apache-2.0), NOTICE, rationale in the charter | |
| Project charter | Done | PROJECT_CHARTER.md, charter page | #1 |
| README | Done | README.md | #2 |
| Public documentation site | Done | This site, built with MkDocs from docs/ and deployed to GitHub Pages on every merge to main by the docs workflow. |
#3 |
| Quality assurance document | Done | Test plan | #4 |
| Code of conduct | Done | CODE_OF_CONDUCT.md (Contributor Covenant 2.1), reporting guide | #5 |
| Pull request workflow | Done | Pull request template, workflow in the test plan, merged pull requests. main is protected: changes need a pull request with passing lint, tests and image build. |
#6 |
Q2: Contribution and transparency¶
| Requirement | Status | Where it is met | Issue |
|---|---|---|---|
| Licence publicly visible | Done | LICENSE in the public repository | |
| Contributing guide | Done | CONTRIBUTING.md, contributing page | #8 |
| Public issues board | Planned | Issues and a public project board | #12 |
| Developer documentation | Done | Architecture, configuration reference, white-label guide | #11 |
| CI with status badge | Done | CI workflow (lint, tests with coverage, migration check, image build); badge in the README | #9 |
| 15% test coverage | Done | Coverage report, rebuilt on every merge to main |
#10 |
Q3: Community¶
| Requirement | Status | Where it is met | Issue |
|---|---|---|---|
| 45% test coverage | Planned | Coverage report | |
| Issue templates | Done | Issue templates for bugs and feature requests | #24 |
| At least 3 good first issues | Planned | good first issue label |
|
| Public discussion channel | Planned | GitHub Discussions | #26 |
| User documentation | Planned | Guides for people running a deployment, on this site | #27 |
| Governance document | Planned | GOVERNANCE.md |
#25 |
Q4: Sustainability¶
| Requirement | Status | Where it is met | Issue |
|---|---|---|---|
| Documentation 1.0 | Planned | This site | |
| 80% test coverage | Planned | Coverage report | |
| Digital Public Goods review | Planned | DPG Standard self-assessment, with evidence kept in the repository | #28 |