Skip to content

Commit d72c5ec

Browse files
chore: Update back-compact / forward-compat defs
Amend the definitions of "backward compatibility" and "forward compatibility" in the "Compatibility and Migration" section of the RFD template to more clearly explain requirements for RFD writers. In the future we'd like this section to be more rigorous, and ideally to provide a detailed breakdown of what kinds of changes in the schema are considered "breaking," but the versioning rules for the CVE Record Format aren't sufficiently defined yet. I recommend developing an RFD to solidify the versioning rules, and then amending the template to require greater rigor around compatibility in this section. Signed-off-by: Andrew Lilley Brinker <abrinker@mitre.org>
1 parent 8f511e7 commit d72c5ec

1 file changed

Lines changed: 8 additions & 3 deletions

File tree

rfds/_TEMPLATE.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,11 +75,16 @@ compatibility.
7575

7676
To address backward compatibility, explain if and how your proposal would
7777
impact users of the schema's ability to parse existing CVE records produced
78-
under prior versions of the CVE Record Format.
78+
under prior versions of the CVE Record Format. Note that CVE records returned
79+
by CVE Services are automatically updated to use new schema versions, so
80+
interaction with historic CVE records would only arise for records stored and
81+
obtained outside of CVE Services.
7982

8083
To address forward compatibility, explain if current users of the schema would
81-
be able to accept all, some, or none of the records produced with the schema as
82-
modified by your proposal.
84+
be able to parse all, some, or none of the records produced with the schema as
85+
modified by your proposal. If CVE consumers would need to amend their existing
86+
parsers for CVE records be able to parse records produced under the new schema,
87+
describe what amendments would be necessary for them.
8388

8489
These explanations must specifically answer the following questions:
8590

0 commit comments

Comments
 (0)