everypolitician / commons-builder

Build scripts for Democratic Commons repositories
MIT License
1 stars 0 forks source link

Generate summaries for each legislature and term #84

Open jacksonj04 opened 6 years ago

jacksonj04 commented 6 years ago

At the moment each term is stored in a folder such as legislative/Q12345/Q67890. Whilst entirely sensible for machines who can quickly parse the index files, this isn't much use to humans who may be interested in what each folder contains.

Proposal

As part of the build process, each of these subfolders (both the legislature and the term) should gain a summary.json (similar to EveryPolitician) with labels and headline statistics, as well as a readme.md with a human readable version of the same.

Why?

The machine readable summaries are immediately useful for downstream tools such as the Commons Explorer, and the human readable version makes pointing interested parties directly at a legislature or term folder on GitHub more feasible.