Everything you see in this portal is built from files kept in one open, public place on GitHub. You don't need to code to use it. This page explains what GitHub is, why the Commons uses it, and what you can do there at each level of confidence.
GitHub is a website for keeping files that many people work on together. Think of it as a shared folder that remembers every change ever made, who made it and why, with a noticeboard attached where anyone can raise a problem or suggest an improvement. A project's folder on GitHub is called a repository (or "repo").
The Commons repository is github.com/cyberdudeuk/dq-commons. It is public, so anyone can read it, and free to reuse: code under the MIT licence and documentation and content under CC BY 4.0.
Background, aims and desired outcomes of the Commons itself are on About the Commons.
GitHub's own guide is a good next step: Hello World (about 10 minutes).
Everything you can do in the portal has a matching place on GitHub. Every portal form opens the GitHub form below, already filled in with what you typed, and the portal shows the results (published contributions, survey totals, votes) after its daily update. You need a free GitHub account to submit; if you don't have one, ask a colleague to send it, or say so in the contact form.
| In the portal | On GitHub | Good to know |
|---|---|---|
| Contact us (every page footer, Help us build this) | Issue form: Contact the Commons | The portal fills the form in for you. No email address is shown or needed. |
| Suggest a feature, wishlist | Issue form: Feature request or wish; issues labelled wishlist | A thumbs-up reaction on a wish is a vote. The portal shows the counts on Help us build this. |
| Share a resource, case study, event, blog, video or podcast | Issue form: Contribute to the library | Moderators review it within 10 working days (the Triage workflow flags anything waiting). |
| Report a problem | Issue form: Something isn't working | Use made-up example data. |
| Add a rule, identifier, value set or framework pack | Issue form: Rule or pack | Or open a pull request with the YAML file. |
| Ask the Commons for help (commission) | Issue form: Ask for help | We reply on the issue. |
| Roadmap (Now, Next, Later, Done) | Milestones | Kept in step with the portal automatically when the backlog changes. |
| Backlog | Issues labelled backlog; needs-people marks prepared items waiting on people | Comment to discuss, or say you're picking it up. |
| Co-design, ideas and questions | Discussions: Ideas, Q&A, Show and tell | Comment in your own time, from any time zone. |
| What's new, releases | Releases | Each version has notes, a source zip and an offline copy of the portal. Watch the repository (Custom, Releases) to be told. |
| Pipeline status | Actions: Data quality pipeline; issues labelled dq-escalation | Runs every Monday; anyone with access can press Run workflow. |
| Content health, broken links, settings | Actions: Content health, Link check, Repository health; one tracked issue each | Opened when there is a problem, updated while it lasts, closed when it is fixed. |
| Accessibility statement | Actions: Accessibility (axe-core on every change) | A pull request that breaks accessibility can't pass. |
| Every page's change history | Commit history for that page | Linked from each page footer. |
| Security | Private vulnerability reporting, secret scanning, Dependabot, CodeQL | Report problems privately, never in a public issue. |
| The portal itself | GitHub Pages, built by the publish portal workflow | Every change to main republishes it. |
| Pull requests | Dependency review, automatic area labels, CODEOWNERS review | New dependencies with serious known vulnerabilities, or closed licences, are refused automatically. |
| Downloads you can trust | Signed build provenance and a software bill of materials on each release | Anyone can check a download came from this repository: gh attestation verify FILE -R cyberdudeuk/dq-commons. |
| Citing the Commons | "Cite this repository" (CITATION.cff) | For research and publications. |
The Commons is one of thousands of public sector projects on GitHub. The GitHub Repos Asset Catalogue lists every UK public sector code project, organised by topic, organisation, question and capability, and explained in plain English for people who don't use GitHub. Search it for "data quality" to find checks, validators and dashboards other teams have already built, and reuse them before building your own.
The catalogue and the Commons share an approach: open by default, plain English at three levels, contact by form only, and automatic checks that keep personal data and credentials out of the repository.