Semantic versioning

[EduardoWDias]

Semantic versioning and good practices for using it;

This discussion item is related to #47.

[EduardoWDias]

https://semver.org/

https://semver.org/lang/pt-BR/

[BomDju]

📌 Semantic Versioning: Rules for Version Numbers

🔢 Standard Format

A normal version number MUST take the form:

X.Y.Z

Where:

• X = Major version
• Y = Minor version
• Z = Patch version

Each must be a non-negative integer and MUST NOT contain leading zeroes.

Example progression:

1.9.0 → 1.10.0 → 1.11.0

---

🧱 Major Version (X)

• 0.y.z: Used for initial development.

  • Anything MAY change at any time.
  • The public API SHOULD NOT be considered stable.

• X.y.z (where X > 0):

  • MUST be incremented if backward-incompatible changes are introduced to the public API.
  • MAY include minor and patch level changes.
  • Minor and patch versions MUST be reset to 0 when the major version is incremented.

---

🧩 Minor Version (Y)

• MUST be incremented if:

  • New, backward-compatible functionality is introduced to the public API.
  • Any public API functionality is marked as deprecated.

• MAY be incremented if:

  • Substantial new functionality or improvements are introduced within the private code.
  • It includes patch-level changes.

• Patch version MUST be reset to 0 when the minor version is incremented.

---

🐞 Patch Version (Z)

• MUST be incremented if:
  • Only backward-compatible bug fixes are introduced.

A bug fix is defined as an internal change that corrects incorrect behavior.

---

🚧 Pre-release Versions

A pre-release version MAY be denoted by appending a hyphen and a series of dot-separated identifiers immediately following the patch version.

Rules:

• Identifiers MUST comprise only ASCII alphanumerics and hyphens: [0-9A-Za-z-].
• Identifiers MUST NOT be empty.
• Numeric identifiers MUST NOT include leading zeroes.
• Pre-release versions have lower precedence than the associated normal version.
• A pre-release version indicates that the version is unstable and might not satisfy the intended compatibility requirements of its associated normal version.

Examples:

1.0.0-alpha 1.0.0-alpha.1 1.0.0-0.3.7 1.0.0-x.7.z.92 1.0.0-x-y-z.-- ← (invalid due to empty identifier)

[pedr0limpio]

finish