Skip to content

docs(contributing): switch to Calendar Versioning - #76

Merged
nicomiguelino merged 4 commits into
mainfrom
docs/update-contributing-md
Sep 1, 2026
Merged

docs(contributing): switch to Calendar Versioning#76
nicomiguelino merged 4 commits into
mainfrom
docs/update-contributing-md

Conversation

@nicomiguelino

@nicomiguelino nicomiguelino commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Switches versioning from SemVer to Calendar Versioning (YY.M.PATCH, e.g. v26.8.0).
  • Updates the version bump table and release steps/examples accordingly.
  • NOTE: This PR does not bump the version in package.json. It's a docs-only change describing the new versioning scheme; the actual version bump will happen in a separate PR when we cut the next release.

Use 'git tag -a vX.Y.Z -m "vX.Y.Z"' instead of a bare annotated tag,
since git tag -a always opens an editor unless -m or -F is given.
Copilot AI lite review requested due to automatic review settings August 19, 2026 17:12

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the release instructions for maintainers to ensure tags are created as annotated tags without triggering an interactive editor prompt, aligning the documented process with the repository’s release workflow expectations.

Changes:

  • Replace the bare git tag vX.Y.Z example with an annotated tag command.
  • Add -m "vX.Y.Z" to avoid opening an editor when creating the annotated tag.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Copilot AI review requested due to automatic review settings September 1, 2026 02:45
@nicomiguelino nicomiguelino changed the title docs(contributing): avoid editor prompt when tagging releases docs(contributing): switch to Calendar Versioning Sep 1, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Comment thread CONTRIBUTING.md Outdated
Copilot AI review requested due to automatic review settings September 1, 2026 02:57

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Comment thread CONTRIBUTING.md Outdated
Copilot AI review requested due to automatic review settings September 1, 2026 03:01

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

Suppressed comments (1)

CONTRIBUTING.md:7

  • The scheme is described as YY.M.PATCH, but YY is also described as a non-zero-padded number. That means it’s not always two digits (e.g., 2007 would become 7), so the YY notation can be slightly misleading. Consider clarifying that YY is year % 100 expressed as a non-zero-padded number.
This project follows [Calendar Versioning](https://calver.org/) using a `YY.M.PATCH` scheme (e.g. `v26.8.0`), a SemVer-compatible variant of CalVer. npm requires `package.json` versions to be valid [SemVer](https://semver.org/), which disallows leading zeros in numeric identifiers, so `YY` is the last two digits of the year as a non-zero-padded number (e.g. `26` for 2026), `M` is the non-zero-padded month, and `PATCH` resets to `0` for the first release of a given year/month and increments for subsequent releases within that same month. Git tags are always `v`-prefixed (e.g. `v26.8.0`). Pre-release tags use the format `v26.8.0-rc.1`.

@nicomiguelino
nicomiguelino merged commit bbcffbe into main Sep 1, 2026
5 checks passed
@nicomiguelino
nicomiguelino deleted the docs/update-contributing-md branch September 1, 2026 13:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants