From d2ee875f4cde7c30215e28daa4868d5d675ae1ca Mon Sep 17 00:00:00 2001 From: sanusishafii989 Date: Thu, 23 Jul 2026 18:13:16 +0100 Subject: [PATCH] Docs: add unreleased changelog policy --- CHANGELOG.md | 18 ++++++++++++++++++ README.md | 8 +++++++- 2 files changed, 25 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5cc66c5..78b6a23 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,24 @@ All notable changes to the AnchorNet contracts are documented here. +## [Unreleased] + +> Contributors: add new user-facing or codebase changes under the relevant +> category below using the [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) +> style and concise bullet points. + +### Added + +### Changed + +### Deprecated + +### Removed + +### Fixed + +### Security + ## [0.9.0] ### Added diff --git a/README.md b/README.md index c92026f..3a6f067 100644 --- a/README.md +++ b/README.md @@ -228,7 +228,13 @@ it without an off-chain registry. 1. Fork the repo and create a branch from `main`. 2. Make changes; keep formatting with `cargo fmt --all`. 3. Run `cargo fmt --all -- --check`, `cargo build`, and `cargo test`. -4. Open a pull request. CI will run format check, build, and tests. +4. Update `CHANGELOG.md` by adding a corresponding entry under `## [Unreleased]` + for every pull request that introduces user-facing or codebase changes. +5. Open a pull request. CI will run format check, build, and tests. + +Follow the existing `Keep a Changelog` category headings in `## [Unreleased]` +when adding entries: `Added`, `Changed`, `Deprecated`, `Removed`, `Fixed`, or +`Security`. ## License