Skip to content

docs: add initial CHANGELOG.md using Keep a Changelog standard #41

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

Open
AaineeSinha wants to merge 3 commits into
base: main
Choose a base branch
from
+15 −1
Open

docs: add initial CHANGELOG.md using Keep a Changelog standard #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
de19de5
docs: add initial CHANGELOG.md using Keep a Changelog standard
Jun 5, 2026
b90af9e
docs: address maintainer review updates for changelog,readme,andcontr…
Jun 7, 2026
3f45150
docs: remove escaping backslashes from changelog headers
Jun 7, 2026
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
13 changes: 13 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# 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]

### Added

- Created initial CHANGELOG.md structure following the Keep a Changelog standard.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down