changelog and updates
the public changelog is for user-facing changes. internal automation, admin-only, and workflow notes should not appear there.
quick answer
use the changelog when a shipped change affects users.
use this for
- checking what changed recently
- deciding whether a public change needs a changelog entry
- keeping wiki and release notes aligned
steps
- decide if the change is user-facing.
- prepend a concise changelog entry when it is.
- update the matching wiki page when behavior changed.
- keep internal workflow details out of the public entry.
details to know
- feature, fix, ui, seo, perf, refactor, and docs commits normally need changelog entries.
- chore, ci, build, test, admin-only, and internal security work normally do not.
- wiki pages explain current behavior. changelog explains what changed.
limits and edge cases
- do not invent a public changelog entry for invisible internal work.
- do not let wiki pages promise behavior before it ships.
ready to use the product instead of reading about it?
open app