Skip to content

docs: CHANGELOG.md with the version history (#59) - #62

Merged
compot-dev merged 1 commit into
masterfrom
docs/changelog
Oct 17, 2026
Merged

compot-dev merged 1 commit into
masterfrom
docs/changelog

Conversation

@compot-dev

Copy link
Copy Markdown
Collaborator

Closes #59.

Note: #59 and #60 say main; the default branch of camex is master, and the text uses that.

One section per version, newest first, from the commits between the
version bumps and the notes of the v2.3.8, v3.0.0 and v3.0.1 releases;
3.0.0 marks the protocol v2 break. The READMEs point to it. It keeps
the history once the versioned releases make way for a single latest
release (#60).
@qodo-free-for-open-source-projects

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Tip of the day
💡 Did you know, you can see how risky a PR is at a glance with blast radius labels

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

PR Summary by Qodo

Add version history and link it from all READMEs

📝 Documentation 🕐 10-20 Minutes

Grey Divider

AI Description

• Add a newest-first changelog from 3.0.2 through 2.2.0, including the protocol v2 compatibility
 break.
• Document the planned latest release model ahead of the separate release-workflow PR.
• Link the changelog from the English, Russian, and Simplified Chinese release guides.
Diagram

graph TD
  V["Version source"] --> C["CHANGELOG.md"] --> U["Readers"]
  E["English README"] --> C
  L["Localized READMEs"] --> C
Loading
High-Level Assessment

A standalone changelog linked from each existing language guide is appropriate: it gives release history one maintained location without duplicating the entries across translations. The latest release behavior is documented in anticipation of #60, not implemented by this PR.

Files changed (4) +122 / -0

Documentation (4) +122 / -0
CHANGELOG.mdEstablish the version-by-version change history +113/-0

Establish the version-by-version change history

• Adds dated entries from 3.0.2 back to 2.2.0 and a brief earlier-history note. Calls out the protocol v2 breaking change and describes the planned 'latest' release model.

CHANGELOG.md

README.mdLink the English release guide to the changelog +3/-0

Link the English release guide to the changelog

• Adds a changelog link and says version bumps should add their changelog section in the same PR.

README.md

README.ru.mdLink the Russian release guide to the changelog +3/-0

Link the Russian release guide to the changelog

• Adds the same version-bump guidance in Russian and identifies the linked changelog as English-language.

README.ru.md

README.zh-CN.mdLink the Chinese release guide to the changelog +3/-0

Link the Chinese release guide to the changelog

• Adds the same version-bump guidance in Simplified Chinese and identifies the linked changelog as English-language.

README.zh-CN.md

@compot-dev
compot-dev merged commit b00be74 into master Oct 17, 2026
16 checks passed
@compot-dev
compot-dev deleted the docs/changelog branch October 17, 2026 18:42
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.

Add CHANGELOG.md with the version history

1 participant