Related Jira Issues

Introduction

The following document lists out policies regarding how the FN SDK will make use of Major, Minor, and Patch revision numbers, as well as the approach to deprecating features within the SDK.

...

• The FN SDK will follow an X.Y.Z naming scheme for version numbers where:

  • X represents a MAJOR version

  • Y represents a MINOR version

  • Z represents a PATCH version

• No leading zeroes will be used when writing out non-zero version numbers

• MAJOR, MINOR, and PATCH versions may only be made up of non-negative numerals

• MAJOR versions shall be incremented when a breaking change has been made to the SDK

  • The MINOR and PATCH version must be set to 0 if the MAJOR version has been incremented

• MINOR versions shall be incremented when new, backwards compatible functionality has been added to the SDK

  • If a feature has been deprecated, the MINOR version must also be incremented

  • The PATCH version must be set to 0 when the MINOR version has been incremented

• PATCH version shall be incremented when a backwards compatible bug fix has been made

• A version number of 0.y.z shall be used during development

• The MAJOR version will reach 1.0.0 upon final delivery

• When performing code deprecation, at least one MINOR version must exist with the deprecated code still functioning before fully deprecating the feature

• MAJOR, MINOR, and PATCH version increments shall be performed when the main branch has been updated

  • Changes within a dev branch shall be handled on a case by case basis

• Git checkins will be tagged according to MAJOR, MINOR, or PATCH revisions