rapid7 / ruby_smb

A native Ruby implementation of the SMB Protocol Family
Other
79 stars 82 forks source link

Define our reservations regarding API stability #200

Closed zeroSteiner closed 2 years ago

zeroSteiner commented 2 years ago

These changes define our reservations regarding API stability. They specifically call out that changes to the BinData definitions may change without triggering a major version bump due to how we have been, are and will continue to implement them in an incremental fashion.

The intention is to inform downstream library consumers of what they can rely on for stability and what they should be weary of.

jmartin-tech commented 2 years ago

We can consolidate this land with another open PR to avoid a release that is just a documentation change.