A Markdown changelog records the changes readers need to know between issued versions. Give each release a version or issue identifier, a date and short entries describing the meaningful differences.
Keep planned or unfinished work separate. A changelog should not make a future intention look like something already delivered.

Record changes a reader needs to know. Original instructional illustration; examples are not software screenshots or product test results.
Use a small human-readable structure
# Changelog
## Unreleased
### Changed
- Clarified the example appendix headings.
## 0.2 — 2026-11-05
### Added
- Added a glossary to the example project guide.
### Fixed
- Corrected the link to the example source table.
## 0.1 — 2026-10-29
### Added
- Issued the first example project guide.This is a fictional project-guide example, not Ulet release information. Replace the versions, dates and changes with your own actual issue record.
Keep a Changelog recommends a curated record for people, with identifiable releases and useful change groups. Keep a Changelog guidance.
Describe the effect of the change
“Corrected the link to the source table” tells a reader what is now different. “Updated files” does not tell them whether they need to reread anything.
Use a clear group such as Added, Changed, Removed or Fixed when it helps scanning. Include only the groups that actually have entries for that release.

Keep the release boundary clear. Original instructional illustration; examples are not software screenshots or product test results.
Keep intentions outside issued releases
An Unreleased section can collect completed changes that have not yet been issued. Keep proposed work in a separate task list. At release time, verify which changes are actually present in the files and move those entries under the real version and date.
Do not copy entries into a release merely because a date has arrived. The record must match the files that were actually issued.
Keep different records in their proper roles
A changelog explains what changed for the reader. A decision log can explain why a choice was made, and version filenames help identify the corresponding files. Link to those records when the extra detail is useful.
Do not turn the changelog into a transcript of every spelling edit. Choose the detail level that lets the audience understand the issue's impact.
Check the record before sharing
Match the version and date with the issued files.
Confirm each listed change is present.
Keep unfinished changes out of that release.
Open any reference links.
Retain the older entries so readers can compare versions.
Ulet provides free local Markdown editing on Windows and macOS. Keep CHANGELOG.md with the project source and update it as part of the actual release process.



