Skip to content

docs: CHANGELOG, v0.1.0-alpha.2, release notes workflow #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cedoor merged 1 commit into from
Apr 28, 2026
Merged

docs: CHANGELOG, v0.1.0-alpha.2, release notes workflow #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .cursor/rules/changelog.mdc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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).
16 changes: 16 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
2 changes: 1 addition & 1 deletion Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion crates/squid/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
Loading