Civic.json file addition

code4sac / openbudgetsac.org

Code for Sacramento's Open Budget Project (landing page + D3.js files)

http://openbudgetsac.org

MIT License

16 stars 25 forks source link

Civic.json file addition #62

Open natebass opened 12 months ago

natebass commented 12 months ago

Should we add a civic.json, like what was included in an old version of this repository?

About civic.json, from Code for DC:

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.

Civic JSON Creator: Civic.JSON (Extended) (dc.gov)

MonstersInc-sudo commented 12 months ago

I can volunteer to add the civic.json file to the codebase. Feel free to assign to me.

natebass commented 11 months ago

I want to check if it is deprecated or not before we add it. Maybe we can look for any other active civic tech projects that use a civic.json https://github.com/search?q=civic.json+language%3AJSON&type=code&l=JSON. We can discuss this at our next Community Action Night or possibly ask other former brigade groups in ACT on their discord.

Maybe @feydan or @joelrip would have some insight?

If we decide to go ahead with adding a civic.json file then let's assign @MonstersInc-sudo. Thanks for the offer!

natebass commented 5 months ago

I don't think a lot of projects are currently using civic.json. Active project streetmix https://github.com/streetmix/streetmix/blob/main/civic.json.

Civic.json standard https://open.dc.gov/civic.json/
Civic.json GitHub repo https://github.com/BetaNYC/civic.json

Purpose:

These can be used to power an API-driven community projects list, such as Chicago's (http://opengovhacknight.org/projects.html) or New York City's (http://projects.betanyc.us/#!/).

The question remains if we want to use this or not.

MonstersInc-sudo commented 5 months ago

@natebass ,

I think there is value in keeping a civic.json on each project but it's really not an imperative file.

Benefits:

Quick intro to JSON formatting.
Simple beginner issues
Allows people to feel recognized as a contributor without giving up website space to the recognition
Useful for summarizing our projects in our new website by taking JSON input for each component.

Drawbacks:

Code bloat and not particularly useful?

Let me know your thoughts!

-MonstersInc-sudo