Add a code.json file to the repo
- Dominant language
- Svelte
- Stars
- 26
- Forks
- 22
- PR merge metrics
- No merged PRs in 30d
Description
The SHARE IT Act is going to require greater transparency in software, including publishing a code.json file with each repository.
https://github.com/GSA/openacr-editor and https://github.com/GSA/openacr should both have a code.json file.
The open source team at CMS has done some great work on this with https://github.com/DSACMS/share-it-act-lp & https://dsacms.github.io/share-it-act-lp/
In particular their metadata generator - https://dsacms.github.io/codejson-generator/ - which allows us to point to a GitHub Repo and simply pull many of the easily findable elements. It then has a simple webform for adding the remainder of the items.
This is in many ways very similar to what OpenACR is doing in creating a simple web form which can create machine-readable assets which then can be more easily consumed by government agencies.
Contributor guide
Research direction
Start with the linked codejson-generator and the CMS SHARE IT Act project to understand the required metadata and generated structure. Check how the openacr-editor repository is represented, then add the requested code.json files for openacr-editor and openacr; done means both repositories contain valid, complete metadata files.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100