World map

 

BM

World 12: Career Quest

Docs and changelogs

You will learn: how to tell users what changed, with a changelog.

The problem

Your notes app got an update. A button moved. Users ask: what changed? Your log only says “wip” and “stuff”.

Watch

Tap the line that names this version and its date.

0 of 1 found

A changelog: A list of the changes in each version, written for people. is a diary for users. Each version lists what was added, changed or fixed. The newest version sits on top.

Try it

A popular style, Keep a Changelog, groups entries under headings. Sort each entry.

Drag a card into a box. Or tap the card, then tap the box.

        Predict

        You fix a bug today. The next version ships next week. Where does the note go?

        Try it

        Your CHANGELOG.md is written. Save it in a commit. Start the message with docs:.

        Working folder
        Staging area
        • Empty
        Repository
        • 3 save points
        • fix again
        • stuff
        • wip

        Check

        Good docs grow with the code. Judge each habit.

        Swipe right for good, left for needs work. Or use the buttons.

        1 / 5

        Update the README in the same PR as the feature

        You did it!

        You can now keep a changelog that users understand.

        Go deeper (optional)

        Conventional Commits help here. feat: commits often become Added. fix: commits become Fixed. World 6 covers this style. Some tools draft a changelog from your commits. A human should still edit it. Keep a Changelog also has Deprecated, Removed and Security headings.