Skip to content

Docs: Added new projectURL field + minor docs updates #17

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.

Sign up for GitHub

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

Merged
natalialuzuriaga merged 4 commits into from
May 9, 2025
Merged

Docs: Added new projectURL field + minor docs updates #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bc96c58
Updated descriptions and order in metadata.md to match schema
natalialuzuriaga May 9, 2025
4fde3cd
Add new field: projectURL
natalialuzuriaga May 9, 2025
b2dd28b
Update metadata.md
natalialuzuriaga May 9, 2025
29b7102
Update schema-0.1.0.json
natalialuzuriaga May 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
178 changes: 94 additions & 84 deletions docs/metadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,40 @@ By harmonizing various standards, this opens up the opportunity to share our wor
<td></td>
</tr>
<tr>
<td>vcs (version control system)</td>
<td>projectURL</td>
<td>optional</td>
<td><img src="../assets/cms-logo.jpg" alt="CMS Logo"></td>
<td>str</td>
<td>URL to landing page, demo, or production instance of project</td>
<td></td>
</tr>
<tr>
<td>repositoryHost</td>
<td>required</td>
<td><img src="../assets/cms-logo.jpg" alt="CMS Logo"></td>
<td>str</td>
<td>Location where source code is hosted</td>
<td>
- github.com/CMSgov<br>
- github.com/CMS-Enterprise<br>
- github.com/DSACMS<br>
- github.cms.gov<br>
- CCSQ GitHub
</td>
</tr>
<tr>
<td>repositoryVisibility</td>
<td>required</td>
<td>📜</td>
<td>str</td>
<td>Visibility of repository</td>
<td>
- public<br>
- private
</td>
</tr>
<tr>
<td>vcs</td>
<td>required</td>
<td>🇺🇸</td>
<td>str</td>
Expand All @@ -172,7 +205,15 @@ By harmonizing various standards, this opens up the opportunity to share our wor
<td></td>
</tr>
<tr>
<td>platform</td>
<td>reuseFrequency/forks <br> reuseFrequency/clones</td>
<td>required</td>
<td>📜</td>
<td>obj</td>
<td>Measures frequency of code reuse in various forms</td>
<td></td>
</tr>
<tr>
<td>platforms</td>
<td>required</td>
<td>🌎</td>
<td>arr</td>
Expand Down Expand Up @@ -226,13 +267,21 @@ By harmonizing various standards, this opens up the opportunity to share our wor
<td>required</td>
<td>🌎📜</td>
<td>str</td>
<td>Maintenance status</td>
<td>The dedicated staff that keeps the software up-to-date, if any</td>
<td>
- internal<br>
- contract<br>
- community<br>
- none
</td>
</tr>
<tr>
<td>contractNumber</td>
<td>required</td>
<td>📜</td>
<td>int</td>
<td>Contract number</td>
<td></td>
</tr>
<tr>
<td>date/created <br> date/lastModified date/metadataLastUpdated</td>
Expand All @@ -247,7 +296,7 @@ By harmonizing various standards, this opens up the opportunity to share our wor
<td>required</td>
<td>🇺🇸</td>
<td>arr</td>
<td>Tags associated with the project</td>
<td>Topics and keywords associated with the project to improve search and discoverability</td>
<td></td>
</tr>
<tr>
Expand All @@ -257,6 +306,19 @@ By harmonizing various standards, this opens up the opportunity to share our wor
<td>obj</td>
<td>Point of contact for the release<br>Email of point of contact<br>Name of point of contact</td>
<td></td>
</tr>
<tr>
<td>feedbackMechanisms</td>
<td>required</td>
<td>📜</td>
<td>arr</td>
<td>Array of methods repositories receive feedback. Default value is the URL to GitHub repository issues</td>
<td>
- Submitting issues to repo<br>
- Submitting PRs to repo<br>
- Project website<br>
- Email
</td>
</tr>
<tr>
<td>localisation</td>
Expand Down Expand Up @@ -302,7 +364,7 @@ By harmonizing various standards, this opens up the opportunity to share our wor
<td>required</td>
<td><img src="../assets/cms-logo.jpg" alt="CMS Logo"></td>
<td>str</td>
<td>FISMA security level <a href="https://security.cms.gov/learn/federal-information-security-modernization-act-fisma">link</a></td>
<td>Level of security categorization assigned to an information system under the Federal Information Security Modernization Act (FISMA): <a href="https://security.cms.gov/learn/federal-information-security-modernization-act-fisma">link</a></td>
<td>
- low<br>
- moderate<br>
Expand All @@ -318,6 +380,30 @@ By harmonizing various standards, this opens up the opportunity to share our wor
<td></td>
</tr>
<tr>
<td>project</td>
<td>required</td>
<td><img src="../assets/cms-logo.jpg" alt="CMS Logo"></td>
<td>arr</td>
<td>Project(s) that is associated or related to the repository, if any.</td>
<td>Bluebutton, MPSM, codejson</td>
</tr>
<tr>
<td>systems</td>
<td>optional</td>
<td><img src="../assets/cms-logo.jpg" alt="CMS Logo"></td>
<td>arr</td>
<td>CMS systems that the repository interfaces with or depends on, if any.</td>
<td>IDR, PECOS</td>
</tr>
<tr>
<td>upstream</td>
<td>optional</td>
<td><img src="../assets/cms-logo.jpg" alt="CMS Logo"></td>
<td>arr</td>
<td>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)</td>
<td>augur, uswds</td>
</tr>
<tr>
<td>subsetInHealthcare</td>
<td>required</td>
<td><img src="../assets/cms-logo.jpg" alt="CMS Logo"></td>
Expand All @@ -342,95 +428,19 @@ By harmonizing various standards, this opens up the opportunity to share our wor
- government
</td>
</tr>
<tr>
<td>repositoryHost</td>
<td>required</td>
<td><img src="../assets/cms-logo.jpg" alt="CMS Logo"></td>
<td>str</td>
<td>Location where source code is hosted</td>
<td>
- github.com/CMSgov<br>
- github.com/CMS-Enterprise<br>
- github.com/DSACMS<br>
- github.cms.gov<br>
- CCSQ GitHub
</td>
</tr>
<tr>
<td>maturityModelTier</td>
<td>required</td>
<td><img src="../assets/cms-logo.jpg" alt="CMS Logo"></td>
<td>int</td>
<td>Maturity model tier</td>
<td>1, 2, 3, 4</td>
</tr>
<tr>
<td>contractNumber</td>
<td>required</td>
<td>📜</td>
<td>int</td>
<td>Contract number</td>
<td></td>
</tr>
<tr>
<td>repositoryVisibility</td>
<td>required</td>
<td>📜</td>
<td>str</td>
<td>Visibility of repository</td>
<td>
- public<br>
- private
</td>
</tr>
<tr>
<td>reuseFrequency/forks <br> reuseFrequency/downloads</td>
<td>required</td>
<td>📜</td>
<td>obj</td>
<td>Measures frequency of code reuse in various forms</td>
<td></td>
</tr>
<tr>
<td>feedbackMechanisms</td>
<td>required</td>
<td>📜</td>
<td>arr</td>
<td>Array of methods repositories receive feedback. Default value is the URL to GitHub repository issues</td>
<td>
- Submitting issues to repo<br>
- Submitting PRs to repo<br>
- Project website<br>
- Email
</td>
</tr>
<tr>
<td>project</td>
<td>required</td>
<td><img src="../assets/cms-logo.jpg" alt="CMS Logo"></td>
<td>arr</td>
<td>Maps repositories to projects</td>
<td>bluebutton, codejson</td>
</tr>
<tr>
<td>systems</td>
<td>optional</td>
<td><img src="../assets/cms-logo.jpg" alt="CMS Logo"></td>
<td>arr</td>
<td>Maps repositories to CMS systems</td>
<td>idr</td>
</tr>
<tr>
<td>upstream</td>
<td>optional</td>
<td><img src="../assets/cms-logo.jpg" alt="CMS Logo"></td>
<td>arr</td>
<td>List of upstream repos used, link to SBOM.</td>
<td>augur, uswds</td>
<td>0, 1, 2, 3, 4</td>
</tr>
</tbody>
</table>

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).
23 changes: 16 additions & 7 deletions schemas/schema-0.1.0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -129,7 +134,10 @@
},
"repositoryVisibility": {
"type": "string",
"enum": ["public", "private"],
"enum": [
"public",
"private"
],
"description": "Visibility of repository"
},
"vcs": {
Expand All @@ -151,11 +159,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
Expand Down Expand Up @@ -307,14 +315,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"
}
},
Expand Down Expand Up @@ -350,6 +358,7 @@
"maturityModelTier": {
"type": "integer",
"enum": [
0,
1,
2,
3,
Expand Down