Skip to content

docs: add retrospective CHANGELOG.md and link in README#108

Open
Avonaxe wants to merge 1 commit into
ARPAHLS:mainfrom
Avonaxe:docs/add-changelog
Open

docs: add retrospective CHANGELOG.md and link in README#108
Avonaxe wants to merge 1 commit into
ARPAHLS:mainfrom
Avonaxe:docs/add-changelog

Conversation

@Avonaxe
Copy link
Copy Markdown

@Avonaxe Avonaxe commented May 24, 2026

Description

Adds a retrospective CHANGELOG.md at the repository root based on historical GitHub release notes, formatted according to Keep a Changelog standards. Also adds a link to the changelog in the central navigation menu of the README.md.

Type of Change

  • Skill Proposal: New Skill (Contains manifest.yaml, skill.py, and instructions.md)
  • Bug Report Fix: Non-breaking change which fixes an execution error or framework bug
  • Doc Fix: Documentation Update
  • Framework Feature / RFC Updates: Core Framework Update (Changes to base_skill.py, loader.py, etc.)

Checklist (all PRs)

  • My code follows the Agent Code of Conduct.
  • I have run python -m flake8 . and pytest tests/ locally (or the subset relevant to this change).

New or updated skill (complete only if this PR adds or changes a skill under skills/)

Skipped: Documentation-only PR

Constitution & Safety (if adding or modifying a skill)

Skipped: Documentation-only PR

Related Issues

Closes #91

@rosspeili
Copy link
Copy Markdown
Contributor

Thanks @Avonaxe, this is a strong first pass and closes the intent of #91. The retrospective coverage from v0.2.0–v0.2.9 is thorough and the README nav link is exactly what we wanted.

Approve with minor revisions before merge:

  1. [Unreleased], Please rebase on latest main and add entries for work since v0.2.9, at minimum:

  2. Keep a Changelog, Remove empty ### Fixed / ### Removed sections that only contain (None). KaC guidance says not to include empty sections.

  3. Optional polish (nice to have):

    • Add the SemVer adherence line under the KaC header
    • Quick pass for hidden/special Unicode characters (GitHub flagged the file)
    • One sentence in CONTRIBUTING: “Add user-facing changes to CHANGELOG.md under [Unreleased]; finalize the section when cutting a release”

Manual maintenance is intentional for v1 (per #91), no automation required in this PR.

Happy to merge once 1–2 are addressed. Nice work on the retrospective dig through release history.

@Avonaxe
Copy link
Copy Markdown
Author

Avonaxe commented May 25, 2026

Thanks for the information, will work on it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs]: Add CHANGELOG.md following Keep a Changelog format

2 participants