Skip to content

Commit

Permalink
DRIVERS-2024 BC behavior breaks and semver mantra
Browse files Browse the repository at this point in the history
  • Loading branch information
behackett committed Feb 8, 2022
1 parent 2d52481 commit 71c67c0
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.rst
Expand Up @@ -94,6 +94,14 @@ Drivers follow semantic versioning
Drivers should follow X.Y.Z versioning, where breaking API changes require a
bump to X. See `semver.org <https://semver.org/>`_ for more.

Backward breaking behavior changes and semver
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Backward breaking behavior changes can be more dangerous and disruptive than
backward breaking API changes. When thinking about the implications of a
behavior change, ask yourself what could happen if a user upgraded your library
without carefully reading the changelog and/or adequately testing the change.

Writing Documents
-----------------

Expand Down

0 comments on commit 71c67c0

Please sign in to comment.