From de19de5ff69ee002ef4ddaff44a21e52a63d207e Mon Sep 17 00:00:00 2001 From: Aainee Sinha Date: Fri, 5 Jun 2026 14:00:31 +0530 Subject: [PATCH 1/3] docs: add initial CHANGELOG.md using Keep a Changelog standard --- CHANGELOG.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..ccb77e5 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,11 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +### Added +- Created initial CHANGELOG.md structure following the Keep a Changelog standard. \ No newline at end of file From b90af9e49178d84e5e7df7c9c7efb969631131c3 Mon Sep 17 00:00:00 2001 From: Aainee Sinha Date: Sun, 7 Jun 2026 11:19:06 +0530 Subject: [PATCH 2/3] docs: address maintainer review updates for changelog,readme,andcontributing guidelines --- CHANGELOG.md | 19 +++++++++++++------ CONTRIBUTING.md | 2 +- README.md | 1 + 3 files changed, 15 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ccb77e5..a892641 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,11 +1,18 @@ -# Changelog +\# Changelog All notable changes to this project will be documented in this file. -The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), -and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +The format is based on Keep a Changelog, and this project adheres to Semantic Versioning. -## [Unreleased] -### Added -- Created initial CHANGELOG.md structure following the Keep a Changelog standard. \ No newline at end of file + +> \*\*Note:\*\* This project is currently in a pre-release stage. Official versioned release entries will begin tracking here soon. + + + +\## \[Unreleased] + +\### Added + +\- Created initial CHANGELOG.md structure following the Keep a Changelog standard. + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9494067..1bb8bde 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -27,7 +27,7 @@ Use the Feature Request template. Explain the motivation behind the suggestion a ``` 4. **Add Tests**: If you are adding new logic, please include corresponding tests in `tests/test_session.py`. 5. **Submit PR**: Provide a clear description of what the PR changes and why. - +6. **Update Changelog**: Please note that a project changelog exists at `CHANGELOG.md`. Contributors will be requested to update the `[Unreleased]` section of the changelog once official versioned releases begin. --- ## Design Philosophy diff --git a/README.md b/README.md index b1b69cc..8002908 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,7 @@ For deeper insights into how to leverage and modify the framework, please refer - [Use Cases, Examples & Best Practices](docs/EXAMPLES.md) - Parameter cheat sheet, deep persona guide, scenario walkthroughs, and an edge case reference table. - [Testing Strategy](docs/TESTING.md) - How to write and run deterministic tests for multi-agent logic. - [Contributing Guide](CONTRIBUTING.md) - Learn how to contribute to the project, report bugs, and follow our design philosophy. +- [Project Changelog](CHANGELOG.md) - Track all notable updates, fixes, and pre-release changes to the framework. ## Project Structure From 3f451500eca77b245d67d6bf0061d578edf4f370 Mon Sep 17 00:00:00 2001 From: Aainee Sinha Date: Sun, 7 Jun 2026 14:40:56 +0530 Subject: [PATCH 3/3] docs: remove escaping backslashes from changelog headers --- CHANGELOG.md | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a892641..808b7d2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,18 +1,13 @@ -\# Changelog +# Changelog All notable changes to this project will be documented in this file. The format is based on Keep a Changelog, and this project adheres to Semantic Versioning. +> **Note:** This project is currently in a pre-release stage. Official versioned release entries will begin tracking here soon. +## [Unreleased] -> \*\*Note:\*\* This project is currently in a pre-release stage. Official versioned release entries will begin tracking here soon. - - - -\## \[Unreleased] - -\### Added - -\- Created initial CHANGELOG.md structure following the Keep a Changelog standard. +### Added +- Created initial CHANGELOG.md structure following the Keep a Changelog standard. \ No newline at end of file