|
| 1 | +# RFC Discussion Template |
| 2 | + |
| 3 | +Use this template when opening a GitHub Discussion for: |
| 4 | + |
| 5 | +- schema or ontology changes |
| 6 | +- vocabulary additions/changes |
| 7 | +- manifest or context changes |
| 8 | +- breaking changes |
| 9 | +- governance/process changes |
| 10 | + |
| 11 | +Use GitHub Issues for implementation work after an RFC is accepted. |
| 12 | + |
| 13 | +## Title |
| 14 | + |
| 15 | +`[RFC] Short proposal title` |
| 16 | + |
| 17 | +## Summary |
| 18 | + |
| 19 | +One paragraph that explains the proposal and why it matters. |
| 20 | + |
| 21 | +## Problem Statement |
| 22 | + |
| 23 | +What problem or limitation are you trying to solve? |
| 24 | + |
| 25 | +- Who is affected? |
| 26 | +- What is the current pain point? |
| 27 | +- Why is the current behavior insufficient? |
| 28 | + |
| 29 | +## Goals |
| 30 | + |
| 31 | +- Goal 1 |
| 32 | +- Goal 2 |
| 33 | + |
| 34 | +## Non-Goals |
| 35 | + |
| 36 | +- Out-of-scope item 1 |
| 37 | +- Out-of-scope item 2 |
| 38 | + |
| 39 | +## Proposed Change |
| 40 | + |
| 41 | +Describe the proposed design in enough detail for review. |
| 42 | + |
| 43 | +- Affected resources/files (classes, properties, vocab terms, contexts, manifests) |
| 44 | +- URL/IRI patterns (if relevant) |
| 45 | +- JSON-LD/RDF modeling changes |
| 46 | +- Validation or compatibility behavior |
| 47 | + |
| 48 | +## Examples (Optional but Recommended) |
| 49 | + |
| 50 | +Include before/after examples where possible. |
| 51 | + |
| 52 | +```json |
| 53 | +{ |
| 54 | + "example": "Add a concrete snippet here" |
| 55 | +} |
| 56 | +``` |
| 57 | + |
| 58 | +## Alternatives Considered |
| 59 | + |
| 60 | +Describe the alternatives you considered and why they are not preferred. |
| 61 | + |
| 62 | +## Compatibility / Migration Impact |
| 63 | + |
| 64 | +- Is this backward compatible? |
| 65 | +- Does it introduce breaking changes? |
| 66 | +- Is a migration/deprecation path needed? |
| 67 | +- What should existing consumers do? |
| 68 | + |
| 69 | +## Risks / Drawbacks |
| 70 | + |
| 71 | +Technical, operational, maintenance, or community risks and mitigations. |
| 72 | + |
| 73 | +## Open Questions (Feedback Requested) |
| 74 | + |
| 75 | +List the specific questions you want feedback on. |
| 76 | + |
| 77 | +- Should we ... ? |
| 78 | +- Is ... acceptable? |
| 79 | +- Would consumers expect ... ? |
| 80 | + |
| 81 | +## Rollout / Implementation Plan (Optional) |
| 82 | + |
| 83 | +If accepted, outline a likely implementation path. |
| 84 | + |
| 85 | +1. Update schema artifacts |
| 86 | +2. Regenerate manifest |
| 87 | +3. Update docs/examples |
| 88 | +4. Open implementation issue(s) |
| 89 | + |
| 90 | +## Decision / Outcome (Maintainers) |
| 91 | + |
| 92 | +Maintain this section as the discussion progresses. |
| 93 | + |
| 94 | +- Status: Proposed / Accepted / Rejected / Deferred |
| 95 | +- Decision date: |
| 96 | +- Link to implementation issue(s)/PR(s): |
0 commit comments