From bc96c58e0e4ba60cd3f7846e85af51cfbde2ff79 Mon Sep 17 00:00:00 2001 From: Natalia Luzuriaga Date: Fri, 9 May 2025 09:42:43 -0700 Subject: [PATCH 1/4] Updated descriptions and order in metadata.md to match schema Signed-off-by: Natalia Luzuriaga --- docs/metadata.md | 170 +++++++++++++++++++------------------- schemas/schema-0.1.0.json | 20 +++-- 2 files changed, 98 insertions(+), 92 deletions(-) diff --git a/docs/metadata.md b/docs/metadata.md index 944aa91..a2dbd81 100644 --- a/docs/metadata.md +++ b/docs/metadata.md @@ -150,7 +150,32 @@ By harmonizing various standards, this opens up the opportunity to share our wor - vcs (version control system) + repositoryHost + required + CMS Logo + str + Location where source code is hosted + + - github.com/CMSgov
+ - github.com/CMS-Enterprise
+ - github.com/DSACMS
+ - github.cms.gov
+ - CCSQ GitHub + + + + repositoryVisibility + required + πŸ“œ + str + Visibility of repository + + - public
+ - private + + + + vcs required πŸ‡ΊπŸ‡Έ str @@ -172,7 +197,15 @@ By harmonizing various standards, this opens up the opportunity to share our wor - platform + reuseFrequency/forks
reuseFrequency/clones + required + πŸ“œ + obj + Measures frequency of code reuse in various forms + + + + platforms required 🌎 arr @@ -226,13 +259,21 @@ By harmonizing various standards, this opens up the opportunity to share our wor required πŸŒŽπŸ“œ str - Maintenance status + The dedicated staff that keeps the software up-to-date, if any - internal
- contract
- community
- none + + + contractNumber + required + πŸ“œ + int + Contract number + date/created
date/lastModified date/metadataLastUpdated @@ -247,7 +288,7 @@ By harmonizing various standards, this opens up the opportunity to share our wor required πŸ‡ΊπŸ‡Έ arr - Tags associated with the project + Topics and keywords associated with the project to improve search and discoverability @@ -257,6 +298,19 @@ By harmonizing various standards, this opens up the opportunity to share our wor obj Point of contact for the release
Email of point of contact
Name of point of contact + + + feedbackMechanisms + required + πŸ“œ + arr + Array of methods repositories receive feedback. Default value is the URL to GitHub repository issues + + - Submitting issues to repo
+ - Submitting PRs to repo
+ - Project website
+ - Email + localisation @@ -302,7 +356,7 @@ By harmonizing various standards, this opens up the opportunity to share our wor required CMS Logo str - FISMA security level link + Level of security categorization assigned to an information system under the Federal Information Security Modernization Act (FISMA): link - low
- moderate
@@ -318,6 +372,30 @@ By harmonizing various standards, this opens up the opportunity to share our wor + project + required + CMS Logo + arr + Project(s) that is associated or related to the repository, if any. + Bluebutton, MPSM, codejson + + + systems + optional + CMS Logo + arr + CMS systems that the repository interfaces with or depends on, if any. + IDR, PECOS + + + upstream + optional + CMS Logo + arr + Link of the upstream repositories and dependencies used, in the form of a Software Bill of Materials/SBOM (https://github.com/$ORG_NAME/$REPO_NAME/network/dependencies) + augur, uswds + + subsetInHealthcare required CMS Logo @@ -342,95 +420,19 @@ By harmonizing various standards, this opens up the opportunity to share our wor - government - - repositoryHost - required - CMS Logo - str - Location where source code is hosted - - - github.com/CMSgov
- - github.com/CMS-Enterprise
- - github.com/DSACMS
- - github.cms.gov
- - CCSQ GitHub - - maturityModelTier required CMS Logo int Maturity model tier - 1, 2, 3, 4 - - - contractNumber - required - πŸ“œ - int - Contract number - - - - repositoryVisibility - required - πŸ“œ - str - Visibility of repository - - - public
- - private - - - - reuseFrequency/forks
reuseFrequency/downloads - required - πŸ“œ - obj - Measures frequency of code reuse in various forms - - - - feedbackMechanisms - required - πŸ“œ - arr - Array of methods repositories receive feedback. Default value is the URL to GitHub repository issues - - - Submitting issues to repo
- - Submitting PRs to repo
- - Project website
- - Email - - - - project - required - CMS Logo - arr - Maps repositories to projects - bluebutton, codejson - - - systems - optional - CMS Logo - arr - Maps repositories to CMS systems - idr - - - upstream - optional - CMS Logo - arr - List of upstream repos used, link to SBOM. - augur, uswds + 0, 1, 2, 3, 4 +Full schema can be found in [schema-0.1.0.json](../schemas/schema-0.1.0.json). + ### Adding new metadata fields We are open to adding more fields to CMS code.json for any metadata the agency sees value in collecting. Request new metadata fields by filing a metadata field addition issue [here](https://github.com/DSACMS/gov-codejson/issues/new?template=metadata-field-addition.md). diff --git a/schemas/schema-0.1.0.json b/schemas/schema-0.1.0.json index 40bf0c2..fd034da 100644 --- a/schemas/schema-0.1.0.json +++ b/schemas/schema-0.1.0.json @@ -129,7 +129,10 @@ }, "repositoryVisibility": { "type": "string", - "enum": ["public", "private"], + "enum": [ + "public", + "private" + ], "description": "Visibility of repository" }, "vcs": { @@ -151,11 +154,11 @@ "type": "object", "description": "Measures frequency of code reuse in various forms. (e.g. forks, downloads, clones)", "properties": { - "forks": { - "type": "integer" + "forks": { + "type": "integer" }, - "clones": { - "type": "integer" + "clones": { + "type": "integer" } }, "additionalProperties": true @@ -307,14 +310,14 @@ "projects": { "type": "array", "description": "Project(s) that is associated or related to the repository, if any (e.g. Bluebutton, MPSM)", - "items": { + "items": { "type": "string" } }, "systems": { "type": "array", "description": "CMS systems that the repository interfaces with or depends on, if any (e.g. IDR, PECOS)", - "items": { + "items": { "type": "string" } }, @@ -350,6 +353,7 @@ "maturityModelTier": { "type": "integer", "enum": [ + 0, 1, 2, 3, @@ -393,4 +397,4 @@ "maturityModelTier" ], "additionalProperties": false -} +} \ No newline at end of file From 4fde3cd0459c43dc891d3539d092f9ba521677bd Mon Sep 17 00:00:00 2001 From: Natalia Luzuriaga Date: Fri, 9 May 2025 09:44:40 -0700 Subject: [PATCH 2/4] Add new field: projectURL Signed-off-by: Natalia Luzuriaga --- docs/metadata.md | 8 ++++++++ schemas/schema-0.1.0.json | 5 +++++ 2 files changed, 13 insertions(+) diff --git a/docs/metadata.md b/docs/metadata.md index a2dbd81..256e6fa 100644 --- a/docs/metadata.md +++ b/docs/metadata.md @@ -149,6 +149,14 @@ By harmonizing various standards, this opens up the opportunity to share our wor The URL of the public release repository for open source repositories. This field is not required for repositories that are only available as government-wide reuse or are closed (pursuant to one of the exemptions). + + projectURL + optional + CMS Logo + str + URL to landing page, demo or production instance of project + + repositoryHost required diff --git a/schemas/schema-0.1.0.json b/schemas/schema-0.1.0.json index fd034da..14c070d 100644 --- a/schemas/schema-0.1.0.json +++ b/schemas/schema-0.1.0.json @@ -116,6 +116,11 @@ "format": "uri", "description": "The URL of the public release repository for open source repositories. This field is not required for repositories that are only available as government-wide reuse or are closed (pursuant to one of the exemptions)." }, + "projectURL": { + "type": "string", + "format": "uri", + "description": "URL to landing page, demo or production instance of project" + }, "repositoryHost": { "type": "string", "description": "Location where source code is hosted", From b2dd28b529c717dbb8e3b9e3fc851af088967a19 Mon Sep 17 00:00:00 2001 From: Natalia Luzuriaga Date: Fri, 9 May 2025 09:59:10 -0700 Subject: [PATCH 3/4] Update metadata.md --- docs/metadata.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/metadata.md b/docs/metadata.md index 256e6fa..6fd1c4f 100644 --- a/docs/metadata.md +++ b/docs/metadata.md @@ -154,7 +154,7 @@ By harmonizing various standards, this opens up the opportunity to share our wor optional CMS Logo str - URL to landing page, demo or production instance of project + URL to landing page, demo, or production instance of project From 29b7102cb017e6634a7b95cf40c40f0db79b10bb Mon Sep 17 00:00:00 2001 From: Natalia Luzuriaga Date: Fri, 9 May 2025 09:59:34 -0700 Subject: [PATCH 4/4] Update schema-0.1.0.json --- schemas/schema-0.1.0.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/schemas/schema-0.1.0.json b/schemas/schema-0.1.0.json index 14c070d..ee744ee 100644 --- a/schemas/schema-0.1.0.json +++ b/schemas/schema-0.1.0.json @@ -119,7 +119,7 @@ "projectURL": { "type": "string", "format": "uri", - "description": "URL to landing page, demo or production instance of project" + "description": "URL to landing page, demo, or production instance of project" }, "repositoryHost": { "type": "string", @@ -402,4 +402,4 @@ "maturityModelTier" ], "additionalProperties": false -} \ No newline at end of file +}