bondery-changelog

name	bondery-changelog
description	Bondery product changelog format, change categories, commit prefixes, calendar versioning, and release-note workflow. Use when editing docs/changelog/unreleased.mdx, documenting a user-visible or operationally notable change, preparing a release, choosing a conventional commit prefix, recording dependency updates, or drafting release communications.
metadata	{"version":"1.0.0","namespace":"bondery"}

Bondery Changelog

When to use

• Adding a notable change under Unreleased
• Turning unreleased entries into a dated version section
• Choosing a changelog category or commit prefix
• Preparing monthly, patch, hotfix, dependency, or security release notes
• Using changelog entries as source material for a release blog post

Non-negotiables

1. One product changelog — docs/changelog.mdx composes version partials under docs/changelog/ and is the page published by Fumadocs. Edit docs/changelog/unreleased.mdx for in-flight work.
2. Write for users and operators — explain the outcome and affected area, not implementation trivia or commit history.
3. Curate manually — commit prefixes help classify changes, but no script generates the product changelog.
4. Keep Unreleased at the top — collect notable work there until a release is cut.
5. Newest release first — use ## [X.Y.Z] - DD.MM.YYYY and Bondery's calendar version scheme.
6. Call out breaking changes — migrations, environment/config changes, port changes, and temporary client/server incompatibilities need a Breaking section with an upgrade path.
7. Keep ownership separate — deployment sequencing stays in the release workflow; API compatibility rules stay in bondery-api.

Routine internal refactors, test-only changes, and formatting do not need product changelog entries unless they materially affect contributors, self-hosters, release safety, or user behavior.

Decision tree

Task	Read
Decide whether and how to write an entry	references/format.md
Choose a category or commit prefix	references/format.md
Calculate a version or cut Unreleased	references/versioning-and-release.md
Execute deployment, extension gates, or rollback	bondery-release
Document API compatibility or deprecation	bondery-api versioning
Turn release notes into an announcement	Blog post workflow

Full local-reference index: references/README.md.

Changelog checklist (before handoff)

• Only docs/changelog/unreleased.mdx was edited (or a release cut touched docs/changelog/releases/X.Y.Z.mdx and docs/changelog.mdx imports)
• The entry describes a notable user, operator, contributor, security, or release outcome
• The entry is under Unreleased or the correct newest-first dated version
• Category and commit prefix match the change
• Product/app area is named when it makes the impact clearer
• Breaking behavior includes an explicit migration or upgrade note
• Version follows Bondery's year-offset/month/patch scheme
• Release and blog workflows were followed when cutting a release