| Metadata Standard | +Origin | +Icon | +
|---|---|---|
| code.json | +Federal | +๐บ๐ธ | +
| publiccode.yml | +International | +๐ | +
| SHARE IT Act | +Federal | +๐ | +
| Field | +Presence | +Source | +Type | +Description | +Options/Examples | +
|---|---|---|---|---|---|
| name | +required | +๐บ๐ธ๐ | +str | +Name of the project or software | ++ |
| description | +required | +๐บ๐ธ | +str | +A short description of the project. It should be a single line containing a single sentence. Maximum 150 characters are allowed. | ++ |
| status | +required | +๐บ๐ธ๐ | +str | +Development status of the project | +
+ - Ideation + - Development + - Alpha + - Beta + - Release Candidate + - Production + - Archival + |
+
| permissions/license/url permissions/license/name |
+ required | +๐บ๐ธ๐ | +obj | +
+ An object containing description of the usage/restrictions regarding the release. + An abbreviation for the name of the license. The URL of the release license. + |
+ + |
| permissions/usageType | +required | +๐บ๐ธ๐ | +str | +A list of enumerated values which describes the usage permissions for the release: (1) openSource: Open source; (2) governmentWideReuse: Government-wide reuse; (3) exemptByNationalSecurity: The source code is primarily for use in national security system as defined in section 11103 of title 40, USC; (4) exemptByNationalIntelligence: The source code is developed by an agency or part of an agency that is an element of the intelligence community, as defined in section 3(4) of the National Security Act of 1947; (5) exemptByFOIA: The source code is exempt under the Freedom of Information Act; (6) exemptByEAR: The source code is exempt under the Export Administration Regulations; (7) exemptByITAR: The source code is exempt under the the International Traffic in Arms Regulations; (8) exemptByTSA: The source code is exempt under the regulations of the Transportation Security Administration relating to the protection of Sensitive Security Information; (9) exemptByClassifiedInformation: The source code is exempt under the Federal laws and regulations governing the sharing of classified information not covered by exemptByNationalSecurity, exemptByNationalIntelligence, exemptbyFOIA, exemptByEAR, exemptByITAR, and exemptByTSA; (10) exemptByPrivacyRisk: The sharing or public accessibility of the source code would create an identifiable risk to the privacy of an individual; (11) exemptByIPRestriction: The sharing of the source code is limited by patent or intellectual property restrictions; (12) exemptByAgencySystem: The sharing of the source code would create an identifiable risk to the stability, security, or integrity of the agencyโs systems or personnel; (13) exemptByAgencyMission: The sharing of the source code would create an identifiable risk to agency mission, programs, or operations; (14) exemptByCIO: The CIO believes it is in the national interest to exempt sharing the source code; (15) exemptByPolicyDate: The release was created prior to the M-16-21 policy (August 8, 2016)", + | +
+ - openSource + - governmentWideReuse + - exemptByNationalSecurity + - exemptByNationalIntelligence + - exemptByFOIA + - exemptByEAR + - exemptByITAR + - exemptByTSA + - exemptByClassifiedInformation + - exemptByPrivacyRisk + - exemptByIPRestriction + - exemptByAgencySystem + - exemptByAgencyMission + - exemptByCIO + - exemptByPolicyDate + |
+
| permissions/exemptionText | +optional | +๐บ๐ธ๐ | +str | +If an exemption is listed in the 'usageType' field, this field should include a one- or two- sentence justification for the exemption used. | ++ |
| organization | +required | +๐บ๐ธ | +str | +The organization or component within the agency to which the releases listed belong. | +Centers for Medicare & Medicaid Services, 18F, Navy | +
| repositoryURL | +required | +๐บ๐ธ๐ | +str | +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). It can be listed as 'private' for repositories that are closed. | ++ |
| repositoryVisibility | +required | +๐ | +str | +Visibility of repository | +
+ - public + - private + |
+
| vcs | +required | +๐บ๐ธ | +str | +Version control system used | +
+ - git + - hg + - svn + - rcs + - bzr + |
+
| laborHours | +required | +๐บ๐ธ | +int | +Labor hours invested in the project. Calculated through COCOMO & SCC tool | ++ |
| reuseFrequency/forks reuseFrequency/clones |
+ required | +๐ | +obj | +Measures frequency of code reuse in various forms | ++ |
| maintenance | +required | +๐๐ | +str | +The dedicated staff that keeps the software up-to-date, if any | +
+ - internal + - contract + - community + - none + |
+
| contractNumber | +required | +๐ | +array | +Contract number | ++ |
| date/created date/lastModified date/metadataLastUpdated |
+ required | +๐บ๐ธ | +obj | +A date object describing the release | ++ |
| tags | +required | +๐บ๐ธ | +arr | +Topics and keywords associated with the project to improve search and discoverability | ++ |
| contact/email contact/name |
+ required | +๐บ๐ธ๐ | +obj | +Point of contact for the release Email of point of contact Name of point of contact |
+ + |
| feedbackMechanisms | +required | +๐ | +str | +Method a repository receives feedback from the community (i.e. URL to GitHub repository issues page) | +
+ - Submitting issues to repo + |
+
| AIUseCaseInventory | +required | +๐ | +bool | +Indicates if the software is included in the agency's AI use case inventory | +
+ - true + - false + |
+