Skip to content

Commit 38b36d3

Browse files
denelonCopilot
andcommitted
Add Deprecation Path to spec template and instructions
- Add Deprecation Path as a recognized section in specs.instructions.md - Add Deprecation Path section to spec-template.md with comment directive - Fix casing: 'Future considerations' -> 'Future Considerations' in template Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 53b2843 commit 38b36d3

2 files changed

Lines changed: 8 additions & 3 deletions

File tree

.github/instructions/specs.instructions.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,9 @@ Follow the template structure in order:
6161
5. **UI/UX Design** — What the user sees. Include terminal output examples showing exact formatting.
6262
6. **Capabilities** — Subsections for Accessibility, Security, Reliability, Compatibility, and Performance/Power/Efficiency.
6363
7. **Potential Issues** — Known risks, trade-offs, and concerns.
64-
8. **Future Considerations** — What this enables for later. Use this for ideas that are explicitly out of scope.
65-
9. **Resources** — Links to related issues, documentation, schema files, and external references.
64+
8. **Deprecation Path** (when applicable) — If the spec replaces an existing field or feature, include a phased deprecation table.
65+
9. **Future Considerations** — What this enables for later. Use this for ideas that are explicitly out of scope.
66+
10. **Resources** — Links to related issues, documentation, schema files, and external references.
6667

6768
## Content Guidelines
6869

doc/specs/spec-template.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,11 @@ issue id: <github issue id>
5353

5454
[comment]: # What are some of the things that might cause problems with the fixes/features proposed? Consider how the user might be negatively impacted.
5555

56-
## Future considerations
56+
## Deprecation Path
57+
58+
[comment]: # If this spec replaces an existing field or feature, outline the phased deprecation plan. If not applicable, state that explicitly.
59+
60+
## Future Considerations
5761

5862
[comment]: # What are some of the things that the fixes/features might unlock in the future? Does the implementation of this spec enable scenarios?
5963

0 commit comments

Comments
 (0)