document your project for the betterment of humankind
So you've coded up a super awesome tool for your community. Now what? You want to share it, of course!
Well, civic.json is here to help.
It's a small file you put in the base of your project's public repository. Fill it with information explaining what your project's about, its development status, who helped build it, and where people can learn more.
Think of it like a structured "README" file that makes possible things like browseable project pages for your organization or city.
Want to see an example? Here's one for the civic.json specification, itself!
pip install civicjson
Whichever your preference, the schema specification gives more detail about the information that goes into a civic.json file.
Civic.json was originally created by BetaNYC in 2014.
In doing so, we aim to foster collaboration and reuse across government agencies, municipalities, and the citizen-government divide.
Found a bug? Think something could be explained better? Want to propose a modification to the schema? Open up an issue or send us an email at firstname.lastname@example.org.