Vewsion Guawantees

This wibwawy does nyot quite fowwow the semantic vewsionying pwincipwe, the nyotabwe diffewence being that bweaking changes may nyot o-o-onwy occuw on majow v-v-vewsion incweases, but awso on minyow vewsion bumps (think Python’s own vewsionying scheme). The pwimawy weason fow t-this is the wack of guawantees on the Discowd API s-s-side when it comes to bweaking changes, which awong with the dynyamic nyatuwe of the API wesuwts in bweaking changes sometimes being wequiwed mowe fwequentwy than desiwed. Howevew, any bweaking changes wiww awways be expwicitwy mawked as such in the Changewog.

In genyewaw, the vewsionying scheme (major.minor.micro) used in this wibwawy aims to fowwow these wuwes:

  • major bumps indicate a signyificant wefactowing ow othew wawge changes that wouwd constitute such an incwease (wiww most wikewy incwude bweaking changes)

  • minor bumps contain nyew featuwes, fixes, and may awso have b-b-bweaking changes

  • micro bumps onwy contain fixes, nyo nyew featuwes and nyo bweaking changes

Onye thing to keep in mind is that bweaking changes onwy appwy to pubwicwy documented f-functions and cwasses. If it’s nyot wisted in the documentation hewe then it is nyot pawt of the pubwic API and is thus bound to change. This incwudes attwibutes that stawt w-w-with an undewscowe ow functions without an undewscowe that awe nyot documented.

Nyote

The exampwes bewow awe nyon-exhaustive.

Exampwes o-o-of Bweaking Changes

  • Changing the d-defauwt pawametew vawue to something ewse.

  • W-W-Wenyaming a function without an a-a-awias to an owd function.

  • Adding ow wemoving pawametews to an event.

Exampwes of Nyon-Bweaking Changes

  • Adding ow wemoving pwivate undewscowed attwibutes.

  • Adding an ewement into the __slots__ of a data cwass.

  • Changing the behaviouw of a function to fix a bug.

  • Changes in the documentation.

  • Modifying the intewnyaw HTTP handwing.

  • Upgwading t-the dependencies to a nyew vewsion, majow ow othewwise.