Generate clean diff documents programmatically to show spec changes in PR reviews.
Problem:
When specs evolve, reviewers need a clear summary of what changed and why, beyond raw Git diffs.
Solution approaches:
- Programmatic diff document generation for BioSpec files
- Formatted markdown showing before/after for changed fields
- Summary of additions, deletions, and modifications
- Context-aware diffs (e.g., "Added Research Question 3" vs raw line changes)
Note: GitHub already provides diff views in its web interface for PRs, but structured diff documents could enhance readability for non-technical stakeholders.
Use cases:
- PR descriptions automatically populated with spec changes
- "What changed since last PI meeting?" summaries
- Changelog generation for version updates
Output example:
## Spec Changes Summary
### intent.md
- ✏️ Modified RQ1: Refined scope from "explore" to "characterize"
- ➕ Added RQ3: New secondary question about immune infiltration
- 🗑️ Removed Hypothesis 2: No longer relevant per 2025-11-05 meeting
### datasets.md
- ➕ Added Dataset 3: Public reference cohort (GSE12345)
- ✏️ Modified Dataset 1 sample count: 50 → 62 samples
Benefit: Clearer communication of spec evolution for all stakeholders
Generate clean diff documents programmatically to show spec changes in PR reviews.
Problem:
When specs evolve, reviewers need a clear summary of what changed and why, beyond raw Git diffs.
Solution approaches:
Note: GitHub already provides diff views in its web interface for PRs, but structured diff documents could enhance readability for non-technical stakeholders.
Use cases:
Output example:
Benefit: Clearer communication of spec evolution for all stakeholders