-
Notifications
You must be signed in to change notification settings - Fork 2
Schema: Create generic code.json metadata schema #16
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
Closed
Closed
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
2a7c528
Added more FAQs based on questions received
natalialuzuriaga 0e011ab
Move schemas to CMS directory
natalialuzuriaga 87b2db2
Added generic code.json schema
natalialuzuriaga ffceb8f
Update faq.md
natalialuzuriaga 8efc8fd
Updated docs to include generic and agency schemas
natalialuzuriaga c606b87
Updated broken link in README
natalialuzuriaga 37a1ced
Remove mentions of CMS code.json and added actionables for agencies
natalialuzuriaga File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,63 @@ | ||
| # Frequently Asked Questions (FAQ) | ||
| # Frequently Asked Questions (FAQs) | ||
|
|
||
| ## Policies | ||
|
|
||
| ### What is the Federal Source Code Policy / M-16-21? | ||
|
|
||
| ### 1. What is the Federal Source Code Policy / M-16-21? | ||
| The Federal Source Code Policy (M-16-21) is a policy issued by the U.S. government that aims to improve software reuse and collaboration across federal agencies. It requires agencies to: | ||
|
|
||
| - Create an inventory of their custom developed code. | ||
| - Share code within and across agencies to reduce duplication and costs. | ||
| - Maintain metadata records of their software assets for transparency and tracking. | ||
|
|
||
| ### 2. What is the SHARE IT Act of 2024? | ||
| ### What is the SHARE IT Act of 2024? | ||
|
|
||
| The SHARE IT Act of 2024 is legislation designed to enhance transparency, collaboration, and efficiency in government software development. It mandates: | ||
|
|
||
| - Greater adoption of open source software in federal agencies. | ||
| - Improved sharing of government software projects with the public. | ||
| - Standardized reporting on software development and licensing practices. | ||
| - Establishment of metadata guidelines to ensure clear documentation and discoverability of software assets. | ||
|
|
||
| ### 3. What is code.json? | ||
| ### Does the SHARE IT Act also apply retroactively to previous custom-developed code? | ||
|
|
||
| No. The SHARE IT Act applies only to custom-developed code created on or after July 21, 2025. Code developed prior to this date is not subject to its requirements, however, code created after August 8, 2016 is subject to the Federal Source Code Policy. | ||
|
|
||
| ### Are there any source code exemptions under the SHARE IT Act? | ||
|
|
||
| There are [4 exemptions](https://www.congress.gov/bill/118th-congress/house-bill/9566/text/ih#HB45699B7E8734166BE2F6DA2A80F7909): | ||
|
|
||
| 1. Source code developed primarily for use in a national security system | ||
| 2. Source code developed by an agency, or part of an agency, that is an element of the intelligence community | ||
| 3. Source code that falls under the Freedom of Information Act | ||
| 4. Source code identified by the agency’s CIO | ||
|
|
||
| ### Does SHARE IT Act apply to data analysis code? | ||
|
|
||
| Yes. All custom-developed code—whether it involves software applications, data analysis, infrastructure/devops, interoperability, or internal tools/scripts—must reside in a repository, unless it qualifies for one of the [four exemptions](https://www.congress.gov/bill/118th-congress/house-bill/9566/text/ih#HB45699B7E8734166BE2F6DA2A80F7909). | ||
|
|
||
| ## code.json Metadata Standard | ||
|
|
||
| ### What is code.json? | ||
|
|
||
| `code.json` is a metadata file used by U.S. federal agencies to document and share their software projects. It provides: | ||
|
|
||
| - A standardized format for describing open source and custom developed software. | ||
| - Key details such as the project's name, description, license, repository URL, and labor hours. | ||
| - Integration with government wide platforms to facilitate code sharing and reuse. | ||
|
|
||
| ### Why is code.json important? | ||
|
|
||
| By collecting metadata on every software project, this allows the agency to build a comprehensive inventory of agency software, enabling strategic decisions about cost reduction and efficiencies through reuse of code. | ||
|
|
||
| ### Is code.json mandatory for all repositories? | ||
|
|
||
| Yes. As per M-16-21 and the SHARE IT Act, agencies are required to publish metadata on all custom-developed code after August 8th 2016, which is not subject to exemptions (see: Sec 6 of [M-16-21](https://obamawhitehouse.archives.gov/sites/default/files/omb/memoranda/2016/m_16_21.pdf) and <a target="_blank" href="https://www.congress.gov/bill/118th-congress/house-bill/9566/text/ih#HB45699B7E8734166BE2F6DA2A80F7909">SHARE IT ACT exemptions</a>) | ||
|
|
||
| ### I have feedback on additions and improvements to the code.json metadata standard. Where can I share this? | ||
|
|
||
| For CMS, 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). | ||
|
|
||
| ### My agency extended the code.json schema to add more metadata fields. Where can I share this? | ||
|
|
||
| We encourage agencies to contribute by submitting a pull request to [include their extended schema in the repository](../schemas). This helps foster collaboration and ensures shared improvements benefit the wider community. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes. As per M-16-21, agencies are required to publish metadata on all custom-developed code after August 8th 2016, which is not subject to exemptions (see: Sec 6 of M-16-21 and
As per the SHARE IT Act, agencies are required to publish metadata on all custom-developed code after July 22, 2025, , which is not subject to exemptions SHARE IT ACT exemptions)
(point to landing page, right to legislation https://www.congress.gov/118/plaws/publ187/PLAW-118publ187.pdf)