From 69bbc534770d481374cd37569b0a2f7b957e1fa6 Mon Sep 17 00:00:00 2001 From: Cedoor Date: Tue, 28 Apr 2026 15:35:14 +0200 Subject: [PATCH] docs: add CHANGELOG, prerelease alpha.2, and changelog Cursor rule - Add CHANGELOG.md (Keep a Changelog); document v0.1.0-alpha.2 (#26). - Bump `squid` crate to 0.1.0-alpha.2. - Add changelog.mdc (Unreleased on merge; relocate at release). - Link the rule from CLAUDE.md. --- .cursor/rules/changelog.mdc | 19 +++++++++++++++++++ CHANGELOG.md | 16 ++++++++++++++++ CLAUDE.md | 1 + Cargo.lock | 2 +- crates/squid/Cargo.toml | 2 +- 5 files changed, 38 insertions(+), 2 deletions(-) create mode 100644 .cursor/rules/changelog.mdc create mode 100644 CHANGELOG.md diff --git a/.cursor/rules/changelog.mdc b/.cursor/rules/changelog.mdc new file mode 100644 index 0000000..8a16803 --- /dev/null +++ b/.cursor/rules/changelog.mdc @@ -0,0 +1,19 @@ +--- +description: CHANGELOG and release notes (Keep a Changelog) +globs: CHANGELOG.md +alwaysApply: true +--- + +# Changelog + +The repo keeps a root [`CHANGELOG.md`](CHANGELOG.md) in [Keep a Changelog](https://keepachangelog.com/) style. + +## When a PR is merged + +- Add a bullet under **`## [Unreleased]`** describing the user-facing or notable change (Added / Changed / Fixed / etc. as appropriate). Do this in the same PR that introduces the change when possible. +- That section is the draft for the **next** version: at release time, its contents are moved under a new dated `## [x.y.z] - YYYY-MM-DD` heading and `[Unreleased]` is left ready for the following cycle. + +## Releases + +- Version bumps and Git tags should match the sections you add to `CHANGELOG.md`. +- Link references at the bottom of `CHANGELOG.md` must be updated when cutting a release (compare URLs for the new tag). diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..75719b2 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,16 @@ +# Changelog + +All notable changes to this project are documented in this file. + +The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html) for published Rust crates and npm packages. + +## [Unreleased] + +## [0.1.0-alpha.2] - 2026-04-28 + +### Added + +- `CHANGELOG.md` to track releases in Keep a Changelog format ([#26](https://github.com/cedoor/squid/issues/26)). + +[Unreleased]: https://github.com/cedoor/squid/compare/v0.1.0-alpha.2...HEAD +[0.1.0-alpha.2]: https://github.com/cedoor/squid/compare/v0.1.0-alpha.1...v0.1.0-alpha.2 diff --git a/CLAUDE.md b/CLAUDE.md index a3132a8..ae459c9 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -11,3 +11,4 @@ Developer guide for AI assistants working in this repo. Detailed rules live in ` | [constraints.mdc](.cursor/rules/constraints.mdc) | Hard constraints — what NOT to do | | [squid-js.mdc](.cursor/rules/squid-js.mdc) | squid-js TypeScript package, WASM/NAPI shims, build process | | [demo.mdc](.cursor/rules/demo.mdc) | Demo Next.js app and Playwright e2e conventions | +| [changelog.mdc](.cursor/rules/changelog.mdc) | `CHANGELOG.md` (Keep a Changelog), **`[Unreleased]`** on each merge, release flow | diff --git a/Cargo.lock b/Cargo.lock index 7666378..ba38d35 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -670,7 +670,7 @@ checksum = "0fda2ff0d084019ba4d7c6f371c95d8fd75ce3524c3cb8fb653a3023f6323e64" [[package]] name = "squid" -version = "0.1.0-alpha.1" +version = "0.1.0-alpha.2" dependencies = [ "getrandom 0.3.4", "poulpy-core", diff --git a/crates/squid/Cargo.toml b/crates/squid/Cargo.toml index 23e4f67..646e00a 100644 --- a/crates/squid/Cargo.toml +++ b/crates/squid/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "squid" -version = "0.1.0-alpha.1" +version = "0.1.0-alpha.2" edition = "2021" description = "An ergonomic Rust wrapper for Poulpy FHE." license = "MIT"