p4lang / p4runtime

Specification documents for the P4Runtime control-plane API
Apache License 2.0
140 stars 86 forks source link

New protobuf entities should have a comment of the form "Added in x.y.z" #441

Closed smolkaj closed 2 months ago

smolkaj commented 11 months ago

Context: https://github.com/p4lang/p4runtime/pull/432#discussion_r1212101247

I propose that going forward, when adding new fields/messages/services to our P4Runtime protobuf schemas, we always include comments such as

// Added in 1.4.0.

This allows developers to reason about forward/backward compatibility of various sever/client combinations when the server and client may be using different versions of the protobuf schemas.

@jafingerhut @chrispsommers WDYT?

chrispsommers commented 11 months ago

Seems like a good ideato me!

jafingerhut commented 11 months ago

Agreed