Skip to content

Commit bf9490c

Browse files
authored
Merge pull request #4 from DSACMS/decause/static-procurement
How To Procure Software and How to Inventory Code markdown
2 parents 8288d6a + aa611d1 commit bf9490c

2 files changed

Lines changed: 278 additions & 2 deletions

File tree

content/guidance/inventory-code.md

Lines changed: 147 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,150 @@ sidenav: true
1313
sticky_sidenav: true
1414
---
1515

16-
Creating your enterprise code inventory
16+
# Overview
17+
18+
Section
19+
<a href="https://www.whitehouse.gov/wp-content/uploads/legacy_drupal_files/omb/memoranda/2016/m_16_21.pdf" target="_blank">7.2</a>
20+
and <a href="https://www.whitehouse.gov/wp-content/uploads/legacy_drupal_files/omb/memoranda/2016/m_16_21.pdf" target="_blank">7.3</a> of the Source Code Policy require agencies to provide an inventory of their 'custom-developed code' to support government-wide reuse and make Federal open source code easier to find.
21+
22+
Using these inventories, <!--TODO: Fix this URL to be Code.gov after new CNAME is pointed--><a href="https://dsacms.github.io/code-gov/">Code.gov</a> will provide a platform to search federally funded open source software and software available for government-wide reuse.
23+
24+
## Publishing Your Agency's Inventory
25+
26+
Agencies are required to publish their inventories using a standard metadata schema - a JSON file that they'll make available on their agency websites. Agencies are strongly encouraged to use version 2.0.0 of the schema, which is described below. This version includes revisions that make your inventory much more useful and intuitive.
27+
28+
Agencies should make the `code.json` available in the root folder of their website (e.g., https://www.agency.gov/code.json). Code.gov will then retrieve these JSON files daily and compile them.
29+
30+
## Metadata Schema version 2.0.0
31+
32+
The schema fields and definitions are listed below.
33+
Here is <a href="https://github.com/GSA/code-gov-data/blob/master/schemas/schema-2.0.0.json">version 2.0.0 of the metadata schema file in JSON format</a>
34+
with parent/child relationships.
35+
36+
### Agency code.json file location and contents:
37+
<ul>
38+
<li><code>code.json</code> must live in the root directory of your agency’s website.</li>
39+
<li>
40+
<code>code.json</code> must include a single object represented as JSON, with key-value pairs according to the list below.
41+
</li>
42+
</ul>
43+
44+
## Source Code Considerations for AI R&amp;D Models
45+
Consistent with the
46+
<a href="https://bidenwhitehouse.archives.gov/briefing-room/presidential-actions/2025/01/14/executive-order-on-advancing-united-states-leadership-in-artificial-intelligence-infrastructure/">Executive Order on Maintaining American Leadership in Artificial Intelligence (EO 13859)</a>, agencies are directed to improve source code inventory documentation (i.e., agency code.json) to enable discovery and usability of source code AI models.
47+
48+
<table>
49+
<thead>
50+
<tr>
51+
<th scope="col">Field Name</th>
52+
<th scope="col">Tags</th>
53+
</tr>
54+
</thead>
55+
<tbody>
56+
<tr>
57+
<th scope="row">Data Type</th>
58+
<td>Array</td>
59+
</tr>
60+
<tr>
61+
<th scope="row">Definition</th>
62+
<td>
63+
An array of keywords that will be helpful in discovering and searching for the release.
64+
</td>
65+
</tr>
66+
<tr>
67+
<th scope="row">Required</th>
68+
<td>Always</td>
69+
</tr>
70+
<tr>
71+
<th scope="row"><span style="white-space: nowrap;">AI R&amp;D Guidance<span></th>
72+
<td>
73+
Agencies shall include the keyword of <code>usg-artificial-intelligence</code> for all source code determined to support AI R&amp;D. Other keywords can be developed and used as appropriate and coordinated with standard data tagging available on
74+
<a href="https://resources.data.gov/resources/dcat-us-priorities/#data-assets-to-fuel-ai-rd">resources.data.gov</a>.
75+
</td>
76+
</tr>
77+
</tbody>
78+
</table>
79+
<table>
80+
<thead>
81+
<tr>
82+
<th scope="col">Field Name</th>
83+
<th scope="col">Contact</th>
84+
</tr>
85+
</thead>
86+
<tbody>
87+
<tr>
88+
<th scope="row">Data Type</th>
89+
<td>Object</td>
90+
</tr>
91+
<tr>
92+
<th scope="row">Definition</th>
93+
<td>Point of contact information for the release.</td>
94+
</tr>
95+
<tr>
96+
<th scope="row">Required</th>
97+
<td>Always</td>
98+
</tr>
99+
<tr>
100+
<th scope="row"><span style="white-space: nowrap;">AI R&amp;D Guidance</span></th>
101+
<td>Be sure to identify and include domain experts and their contact information who can discuss the model with interested AI researchers. If not the same as the domain expert, Agencies shall also identify an expert and their contact information who can discuss restrictions or controls on the model.</td>
102+
</tr>
103+
</tbody>
104+
</table>
105+
<table>
106+
<thead>
107+
<tr>
108+
<th scope="col">Field Name</th>
109+
<th scope="col">exemptionText</th>
110+
</tr>
111+
</thead>
112+
<tbody>
113+
<tr>
114+
<th scope="row">Data Type</th>
115+
<td>String or Null</td>
116+
</tr>
117+
<tr>
118+
<th scope="row">Definition</th>
119+
<td>If an exemption is listed in the <code>usageType</code> field, this field should include a one or two sentence justification for the exemption used.</td>
120+
</tr>
121+
<tr>
122+
<th scope="row">Required</th>
123+
<td>No</td>
124+
</tr>
125+
<tr>
126+
<th scope="row"><span style="white-space: nowrap;">AI R&amp;D Guidance</span></th>
127+
<td>Agencies shall describe how researchers may be able to access <code>governmentWideReuse</code> or exempt data.</td>
128+
</tr>
129+
</tbody>
130+
</table>
131+
<table>
132+
<thead>
133+
<tr>
134+
<th scope="col">Field Name</th>
135+
<th scope="col">relatedCode</th>
136+
</tr>
137+
</thead>
138+
<tbody>
139+
<tr>
140+
<th scope="row">Data Type</th>
141+
<td>Array</td>
142+
</tr>
143+
<tr>
144+
<th scope="row">Definition</th>
145+
<td>An array of affiliated government repositories that may be a part of the same project. For example, <code>relatedCode</code> for <code>code-gov-front-end</code> would include <code>code-gov-api</code> and <code>code-gov-client</code>.</td>
146+
</tr>
147+
<tr>
148+
<th scope="row">Required</th>
149+
<td>No</td>
150+
</tr>
151+
<tr>
152+
<th scope="row"><span style="white-space: nowrap;">AI R&amp;D Guidance</span></th>
153+
<td>Agencies shall describe related models and code.</td>
154+
</tr>
155+
</tbody>
156+
</table>
157+
158+
## Example code.json file
159+
160+
Here are some [good metadata examples](https://github.com/GSA/code-gov/blob/master/docs/metadata_examples.md) for reference when creating your agency code.json file.
161+
162+
You can find previous schema revisions in [our changelog](https://github.com/GSA/code-gov-data/blob/master/CHANGELOG.md)

0 commit comments

Comments
 (0)