whatisgithub

What is publiccode.yml?

ruphy/publiccode.yml — explained in plain English

Analysis updated 2026-07-16 · repo last pushed 2018-06-26

3ShellAudience · pm founderComplexity · 1/5DormantSetup · easy

In one sentence

A standard file format that government agencies put inside their software projects so other agencies can find and reuse their tools. It captures details like who built it, maintenance status, and legal frameworks it supports.

Mindmap

mindmap
  root((repo))
    What it does
      Standard file format
      Describes gov software
      Human and machine readable
    Use cases
      Find reusable gov tools
      Avoid rebuilding solutions
      Compare across cities
    Audience
      Government IT staff
      Policy teams
      Public admins
    Key details
      Development stage
      Maintenance info
      Legal frameworks
    Status
      Early alpha
      Version 0.1
      Italian Digital Team
    Related efforts
      Crawler scanner
      Open data publishing

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

A city builds a pothole-reporting app and adds a publiccode.yml file so other cities can discover and reuse it.

USE CASE 2

Government IT staff search a catalog of publiccode.yml files to find existing software instead of building from scratch.

USE CASE 3

A policy team evaluates whether a tool built by another administration fits their national legal framework by reading its publiccode.yml.

USE CASE 4

A scanner crawls public code repositories for publiccode.yml files and publishes the results as open data for anyone to browse.

What is it built with?

ShellYAML

How does it compare?

ruphy/publiccode.ymlchrisor-dev/claude-autosyncdangerousyams/muxer
Stars322
LanguageShellShellShell
Last pushed2018-06-26
MaintenanceDormant
Setup difficultyeasymoderatemoderate
Complexity1/53/53/5
Audiencepm founderdeveloperdeveloper

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · easy Time to first run · 5min

No setup required, it is a file format standard, so you just create a YAML file following the spec.

The explanation does not mention a license, so it is unclear what permissions apply to using this project.

So what is it?

The publiccode.yml standard is a simple way for government agencies to describe the software they build, so that other agencies can actually find and reuse it. The idea is that lots of public administrations create useful software tools, but hardly anyone else knows these tools exist or whether they'd work in a different city or country. The project defines a standard file, literally called publiccode.yml, that sits inside a software project and describes it in a consistent way. The file includes things like the project title and description, who built it, what stage of development it's in, who handles maintenance, and what legal or technical requirements it has. The format is meant to be readable by both humans and computers, so a civil servant could open it and understand what the software does, while a search tool could scan it automatically. This would be useful for government IT staff, policy teams, or anyone working in public administration who wants to avoid building a solution from scratch. If one city builds an app for reporting potholes and documents it with this standard, another city could find it and evaluate whether the same approach would work for them. The file captures details that matter for government contexts specifically, like which national legal frameworks the software supports, that you wouldn't find in a typical open-source project's README. The project is still in early development (alpha status) at version 0.1, and was created by the Italian Digital Transformation Team. There's also a related effort to build a scanner that crawls public websites looking for these files and publishes what it finds as open data, making the whole ecosystem more discoverable.

Copy-paste prompts

Prompt 1
Write a publiccode.yml file for a municipal parking-permit web app built by the City of Springfield, currently in beta, maintained by the IT department, compliant with US accessibility standards.
Prompt 2
Generate a publiccode.yml template I can drop into any government open-source project, including fields for description, development status, maintenance contacts, and legal frameworks.
Prompt 3
Compare a standard README file with a publiccode.yml file and show me what government-specific details the publiccode.yml captures that a README usually misses.
Prompt 4
Build a simple script that scans a list of GitHub repository URLs and reports which ones contain a valid publiccode.yml file and extracts their project titles and descriptions.

Frequently asked questions

What is publiccode.yml?

A standard file format that government agencies put inside their software projects so other agencies can find and reuse their tools. It captures details like who built it, maintenance status, and legal frameworks it supports.

What language is publiccode.yml written in?

Mainly Shell. The stack also includes Shell, YAML.

Is publiccode.yml actively maintained?

Dormant — no commits in 2+ years (last push 2018-06-26).

What license does publiccode.yml use?

The explanation does not mention a license, so it is unclear what permissions apply to using this project.

How hard is publiccode.yml to set up?

Setup difficulty is rated easy, with roughly 5min to a first successful run.

Who is publiccode.yml for?

Mainly pm founder.

Open on GitHub → Ask about another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.