Skip to content

Commit 9579891

Browse files
feat: Expand migration requirements in template.
At Matt Powers' recommendation, this amends the "Compatibility and Migration" section of the RFD template to describe expectations for analyzing and planning migrations more clearly, including specific questions which ought to be answered, and clarifying the limits of SchemaVer in expressing the adoption burden of new features. Signed-off-by: Andrew Lilley Brinker <abrinker@mitre.org>
1 parent 1e81089 commit 9579891

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

rfds/_TEMPLATE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,27 @@ Also describe any migration paths required of CVE stakeholders, including any
8787
requirement to transition from a prior structure in the schema to a new
8888
structure, or to comply with stricter data quality constraints.
8989

90+
Some of the following questions may be important to answer, depending on the
91+
scale of the changes proposed in an RFD:
92+
93+
- How long should the proposed change be communicated to CVE stakeholders in
94+
advance of being rolled out in CVE Services?
95+
- What types of testing are necessary before the change is rolled out into
96+
production? (This testing may also be part of the Success Metrics and
97+
rollback criteria.)
98+
99+
While SchemaVer's compatibility rules only consider the impact of a change on
100+
the ability of users of a schema to interact with _historic_ data, any change
101+
to the schema which adds new capabilities places a demand on CVE stakeholders
102+
to adapt. For CNAs and ADPs this may mean updating their integrations with
103+
CVE Services to provide data in new fields, while for CVE consumers it may
104+
require amending their CVE record parsing to make use of new data or be able to
105+
parse new records.
106+
107+
This fact, that `ADDITION`-level changes still create work for CVE stakeholders,
108+
should never be used as a sole reason to reject a proposed RFD, but it should
109+
strongly inform any roll out plan for changes.
110+
90111
## Success Metrics
91112
[success-metrics]: #success-metrics
92113

0 commit comments

Comments
 (0)