Practise the standard verbs for writing clear, useful changelog entries.
0 / 5 completed
1 / 5
Fill in: 'We ___ every user-facing change to a changelog entry, in plain language, rather than assuming a user will read the raw commit history to find out what changed.'
We 'add an entry' — the standard, simple collocation for recording a change in a changelog. The other options are less idiomatic here.
2 / 5
Fill in: 'Writing a changelog entry that's just a copied commit message can ___ a user with no engineering context genuinely unable to tell if the change affects them.'
We say an unclear entry will 'leave' a user unable to tell if it affects them — the standard, natural collocation for the resulting confusion. The other options aren't idiomatic here.
3 / 5
Fill in: 'We ___ breaking changes clearly at the top of a release's notes, since a user skimming quickly should never have to hunt for the one entry that actually matters.'
We 'flag a change' — the standard, simple collocation for highlighting an especially important entry. The other options are less idiomatic here.
4 / 5
Fill in: 'We ___ changelog entries by category, added, fixed, changed and deprecated, so a reader scanning for one type of update doesn't have to read every single line.'
We 'group entries' — the standard, simple collocation for organising a changelog by change type. The other options are less idiomatic here.
5 / 5
Fill in: 'We ___ a migration link directly in the changelog entry for any breaking change, so a user isn't left searching separately for the steps they now need to take.'
We 'include a link' — the standard, simple collocation for embedding a helpful reference in an entry. The other options aren't idiomatic here.