Skip to content

Commit 1d01ba9

Browse files
adamdoeCopilot
adamdoe
and
Copilot
authored
enhancement: add readme-maintainer skill and update readme (#2710)
* enhancement: add readme-maintainer skill and update readme * fix: markdown * fix: remove related section * Update .agents/skills/readme-maintainer/SKILL.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent 1237ecd commit 1d01ba9

File tree

2 files changed

+443
-48
lines changed

2 files changed

+443
-48
lines changed

‎.agents/skills/readme-maintainer/SKILL.md‎

Lines changed: 292 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,292 @@
1+
---
2+
description: "Review and maintain README.md for accuracy against the current repository contents"
3+
name: "README Maintainer"
4+
argument-hint: "Optional focus, for example: refresh usage, prerequisites, or do a full accuracy pass"
5+
agent: "agent"
6+
---
7+
Maintain [README.md](../../../README.md) with an accuracy-first pass.
8+
9+
Requirements:
10+
- Inspect the current workspace before editing.
11+
- Prefer minimal changes that correct drift between the README and checked-in files.
12+
- Verify script names, paths, prerequisites, usage examples, and any documented generated or runtime directories.
13+
- Replace unresolved placeholders (identified by brackets {}) in README metadata when the intended value can be inferred from the repository context; otherwise call out the uncertainty explicitly with a TODO.
14+
- When filling `{Keywords}`, use only exact terms from the approved taxonomy provided in the following JSON that has the terms grouped by top-level categories:
15+
16+
{
17+
"Public Health Surveillance & Early Detection": [
18+
"surveillance", "monitoring", "biosurveillance", "outbreak", "cluster",
19+
"disease tracking", "disease surveillance", "epidemiology", "epidemiologic",
20+
"syndromic", "case reporting", "case notification", "case-based",
21+
"vital statistics", "birth certificate", "death certificate",
22+
"mortality", "morbidity", "incidence", "prevalence",
23+
"nndss", "reportable", "notifiable", "sentinel", "signal detection"
24+
],
25+
"Disease Prevention, Health Promotion & Community Programs": [
26+
"prevention", "preventive", "risk reduction", "harm reduction",
27+
"screening", "early detection", "health promotion", "health improvement",
28+
"wellness", "behavior change", "behavioral", "intervention",
29+
"vaccination", "immunization", "vaccine", "immunisation",
30+
"health education", "outreach", "community", "community program",
31+
"communication", "health communication", "campaign", "social marketing",
32+
"guidelines", "recommendations", "best practices",
33+
"maternal health", "child health", "school health"
34+
],
35+
"Clinical & Healthcare System Support": [
36+
"clinical", "clinical support", "patient", "provider", "physician",
37+
"nursing", "nurse", "clinic", "hospital", "care team",
38+
"ehr", "electronic health record", "emr", "chart", "medical record",
39+
"treatment", "care management", "care coordination",
40+
"workflow", "order entry", "cpoe", "rounding",
41+
"telehealth", "telemedicine", "virtual care",
42+
"triage", "diagnosis", "clinical decision support", "cds",
43+
"clinical quality", "quality measure", "hitrust", "joint commission"
44+
],
45+
"Data Exchange, Standards & Interoperability": [
46+
"interoperability", "data exchange", "data sharing", "integration",
47+
"interface", "interfaces", "api", "rest api", "graphql",
48+
"hl7", "hl7v2", "v2", "fhir", "cda", "ccda",
49+
"health information exchange", "hie", "edi",
50+
"terminology", "vocabulary", "coding system", "codeset",
51+
"loinc", "snomed", "icd", "icd-10", "rxnorm",
52+
"xml", "json", "csv", "ndjson",
53+
"message mapping", "schema", "schema validation"
54+
],
55+
"Analytics, Research & Public Health Decision Support": [
56+
"analytics", "analysis", "data analysis", "data science",
57+
"reporting", "reports", "dashboard", "scorecard", "kpi",
58+
"business intelligence", "bi", "visualization", "chart", "graph",
59+
"statistics", "statistical", "model", "modeling", "forecasting",
60+
"projection", "scenario", "trend", "time series",
61+
"research", "study", "cohort", "evaluation", "outcome evaluation",
62+
"survey", "census", "questionnaire",
63+
"machine learning", "ml", "ai", "artificial intelligence",
64+
"natural language processing", "nlp",
65+
"risk stratification", "decision support", "policy analysis"
66+
],
67+
"Laboratory Science, Genomics & Advanced Molecular Detection": [
68+
"laboratory", "lab", "public health lab", "phl",
69+
"genomics", "genomic", "genotype",
70+
"sequencing", "sequence", "ngs", "next-generation sequencing",
71+
"molecular", "pcr", "assay", "serology", "viral load",
72+
"bioinformatics", "pipeline", "alignment", "variant calling",
73+
"lims", "laboratory information management",
74+
"specimen", "sample", "isolate", "strain",
75+
"amd", "advanced molecular detection", "phylogenetic"
76+
],
77+
"Public Health Emergency Preparedness & Response": [
78+
"emergency", "emergencies", "emergency response", "response",
79+
"preparedness", "readiness", "resilience", "all-hazards",
80+
"incident management", "incident command", "ics",
81+
"emergency operations", "eoc", "operations center",
82+
"rapid response", "surge", "deployment",
83+
"biopreparedness", "bioterrorism", "anthrax",
84+
"contingency plan", "emergency plan", "continuity of operations",
85+
"tabletop exercise", "drill", "exercise",
86+
"crisis", "disaster", "hurricane", "flood", "earthquake", "wildfire"
87+
],
88+
"Administrative, Financial & Program Operations": [
89+
"administrative", "administration", "operations", "operational",
90+
"program management", "project management", "pmo",
91+
"hr", "human resources", "personnel", "staffing",
92+
"training", "onboarding", "performance", "pmap",
93+
"budget", "finance", "financial", "cost", "costing",
94+
"billing", "claims", "revenue cycle",
95+
"procurement", "acquisition", "contract", "contracting",
96+
"grant", "grant management", "cooperative agreement", "co-ag",
97+
"governance", "compliance", "policy", "sop",
98+
"timekeeping", "travel", "inventory", "asset management"
99+
]
100+
}
101+
102+
- When filling `{Project Status}` placeholder it should be replaced with one of the following:
103+
-- Initiation
104+
-- Development
105+
-- Operations and Maintenance (O\&M)
106+
-- Retired
107+
- Prefer taxonomy terms that describe the repository's operational purpose; avoid inventing synonyms, category labels, or implementation-detail keywords unless they appear verbatim in the taxonomy.
108+
- Preserve the existing tone and structure unless a small reorganization improves clarity.
109+
- Update README.md directly when inaccuracies are found.
110+
- If a detail depends on external infrastructure and cannot be verified from the repo, keep the wording explicit about that uncertainty.
111+
- Use the exact markdown outline and section order provided below between "***** START README TEMPLATE *****" and "***** END README TEMPLATE *****":
112+
113+
```md
114+
***** START README TEMPLATE *****
115+
# {Project Name}
116+
117+
> {Project Overview}
118+
119+
---
120+
121+
## Required Project Organization Information
122+
- Organization: Office of Communications (OC)
123+
- Contact Email: \[imtech@cdc.gov](mailto:imtech@cdc.gov)
124+
- Status: {Project Status}
125+
- Keywords: {Mission Area Keywords}
126+
- Version: yyyyMMdd.HHmmss
127+
128+
## Other Project Organization Information
129+
- Point of Contact: \[{Project Tech Lead Name}](mailto:{Project Tech Lead Email})
130+
- Related Project(s): {Related Projects}
131+
- Program Official: \[{FTE Lead Name}](mailto:{FTE Lead Email})
132+
133+
---
134+
135+
## Project Description
136+
137+
{Project Description}
138+
139+
- **What does it do?**
140+
- **What problem does it solve?**
141+
- **Who is it for?**
142+
143+
---
144+
145+
## Project Status
146+
147+
This project is currently in \*\*Production\*\*.
148+
149+
| Environment | Status |
150+
|-------------|--------|
151+
| Development | Active |
152+
| Staging | Active |
153+
| Production | Active |
154+
155+
---
156+
157+
## Features
158+
159+
{Project Features - Bullet List}
160+
161+
---
162+
163+
## Prerequisites
164+
165+
Before you begin, ensure you have the following installed:
166+
167+
{Project Prerequisites - Bullet List}
168+
169+
### Required Credentials
170+
171+
{Project Required Credentials - Optional Bullet List Section if Applicable}
172+
173+
---
174+
175+
## Installation
176+
177+
{Installation Instructions}
178+
179+
## Usage
180+
181+
{Usage Instructions}
182+
183+
---
184+
185+
## Configuration
186+
187+
{Configuration Settings}
188+
189+
---
190+
191+
## Architecture
192+
193+
{Architecture - description or pointer to separate documentation under \[ARCHITECTURE.md](./docs/ARCHITECTURE.md) if lengthy}
194+
195+
---
196+
197+
## Testing
198+
199+
{Testing Steps - description or pointer to separate documentation under \[TESTING.md](./docs/TESTING.md) if lengthy}
200+
201+
---
202+
203+
## API Documentation {if applicable otherwise don't include section}
204+
205+
{API Documentation - description or pointer to separate documentation under \[API.md](./docs/API.md) if lengthy}
206+
207+
---
208+
209+
## Logging {if applicable otherwise don't include section}
210+
211+
{Logging Documentation}
212+
213+
---
214+
215+
## Security
216+
217+
### Reporting a Vulnerability
218+
219+
**Do not open a public GitHub issue for security vulnerabilities.**
220+
221+
Please report security issues by emailing **[imtech@cdc.gov](mailto:imtech@cdc.gov)**.
222+
223+
### Security Considerations
224+
225+
### Sensitive Data
226+
227+
---
228+
229+
## Troubleshooting
230+
231+
---
232+
233+
## Accessibility
234+
235+
This project is committed to being accessible to all users as applicable.
236+
237+
- **Section 508 Compliance:** Not Applicable (Backend Service)
238+
- **WCAG 2.1 Level:** Not Applicable (Backend Service)
239+
- To report an accessibility issue, contact \[imtech@cdc.gov].
240+
241+
---
242+
243+
## Disclaimer
244+
245+
This project is maintained by CDC. It is provided "as is" without warranty of any kind. References to any specific commercial product, process, or service do not constitute or imply endorsement by the U.S. Government.
246+
247+
---
248+
249+
## Development
250+
251+
### Building the Solution (if applicable)
252+
253+
### Project Structure
254+
255+
### Dependencies
256+
257+
## Contributing
258+
259+
This is an internal CDC project. For contributions or questions, contact the Point of Contact or email imtech@cdc.gov.
260+
261+
---
262+
263+
## Changelog
264+
265+
See the git commit history for detailed changes:
266+
267+
```bash
268+
git log --oneline
269+
```
270+
271+
***** END README TEMPLATE *****
272+
273+
```
274+
275+
---
276+
277+
Additional instructions:
278+
279+
- Infer the project name from the repository folder, package metadata, or existing docs.
280+
- Include fenced code blocks for commands.
281+
- For Repository Structure, summarize the main folders in a short bullet list.
282+
- For Testing, include the actual test commands only if found in the codebase.
283+
- For Build and Deployment, include only commands or workflows supported by the repo.
284+
- For Architecture Notes, summarize major modules/components only if they can be inferred confidently.
285+
- After editing, provide a short summary of what was inferred versus what remains TODO.
286+
287+
288+
Deliverables:
289+
- A corrected README.md when changes are needed.
290+
- A concise summary of what changed and any remaining assumptions.
291+
292+

0 commit comments

Comments
 (0)