Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New civic.json fields #8

Open
ameensol opened this issue Jun 12, 2014 · 2 comments
Open

New civic.json fields #8

ameensol opened this issue Jun 12, 2014 · 2 comments

Comments

@ameensol
Copy link

The meta question: Is there a certain process for adding new fields to the civic.json standard?

Code for DC is hoping to change to a civic.json powered projects page, but they have some fields that they want to include that aren't described by the current spec. Here is the civic.json file I built for one of their projects, using data from the Code for DC projects page.

The fields I added that aren't on the standard are below:

{
"contact": [
    {
      "name": "Marcus Louie",
      "email": "",
      "twitter": "@mlouie"
    }
  ],
  "communityPartner": "Bread for City",
  "moreInfoLink": "https://hackpad.com/Code-for-DC-District-Housing-KlQ2UbX0Imc"
}

I'm sure there are other fields that civic hackers will want to include as this standard develops, so I was hoping to start a conversation about what this process will look like.

@junosuarez
Copy link

I like the example given by npm's package.json, GeoJSON, and OKFN's datapackage.json - they each specify minimum required fields, and mention additional optional fields, and then allow for whatever other fields beyond that as valid. This allows for experimentation and interoperability with other tools. For example, the JavaScript tool jshint allows embedding config in package.json

@chriswhong
Copy link
Contributor

+1, I think we should agree on a set of minimum required fields, standard
optional fields, and then free for all beyond that for whatever suits a
person or org's needs.
On Jun 11, 2014 9:40 PM, "Jason Denizac" [email protected] wrote:

I like the example given by npm's package.json
https://www.npmjs.org/doc/json.html, GeoJSON
http://geojson.org/geojson-spec.html, and OKFN's datapackage.json
http://dataprotocols.org/data-packages/ - they each specify minimum
required fields, and mention additional optional fields, and then allow for
whatever other fields beyond that as valid. This allows for experimentation
and interoperability with other tools. For example, the JavaScript tool
jshint allows embedding config in package.json
http://www.jshint.com/blog/better-npm-integration/


Reply to this email directly or view it on GitHub
#8 (comment).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants