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

Explore creating a cookiecutter.json config #1

Open
decause-gov opened this issue Oct 30, 2024 · 3 comments
Open

Explore creating a cookiecutter.json config #1

decause-gov opened this issue Oct 30, 2024 · 3 comments

Comments

@decause-gov
Copy link
Collaborator

decause-gov commented Oct 30, 2024

Using a metadata standard like publiccode.yaml, or code.json, we can use cookiecutter to gather metadata about which SDG's a project is related to.

Links for reference:

@decause-gov
Copy link
Collaborator Author

01/08 Update: our team has been experimenting with using Static Web Forms generated from json configuration files to gather repository metadata manually from users from the web, in addition to Cookiecutter, which gathers data from the commandline. We will update this ticket with a link to our repository when the code is shipped :)

@david-lippert
Copy link
Collaborator

Software Heritage uses Codemeta.json which is based on schema.org. This might be another standard to research.

It is not clear to me how to define a standard, but here are some requirements off the top of my head:

  • broad enough to support research & production projects as well as projects of different types (tech, non-tech, etc.)
  • leveraging existing standards (schemas, protocols (json, yml, md))
  • interoperable across multiple environments (not just supporting github)
  • lightweight and easy to create (by maintainers or contributors) and use (by APIs)
  • flexible to add more details when available, but minimal details are still useful (e.g. just SDG = 13 useful, but add justification for high relevancy and details about addressing specific targets or indicators as well)
  • clear language to communicate to the world (can we even use SDG or should we spell it out)

@decause-gov
Copy link
Collaborator Author

IDEA: Fork the codejson-generator project to create a form for determining what SDG a project relates to.

Convert the SDG indicators into questions like "Does your project help to eradicate poverty?" https://sdgs.un.org/goals/goal1#targets_and_indicators
and then export file that adds that metadata file that can be added to repo.

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

No branches or pull requests

2 participants