Commit messages 

These conventions apply to every contribution, no matter whether you make your change directly on GitHub or locally with Docker.

Example commit message 
[TASK] Add missing alt text for screenshots

Screen reader users could not tell what the two new screenshots showed.
Add descriptive alt text to both.

Assisted-by: Claude Sonnet 5 <noreply@anthropic.com>
Signed-off-by: Jane Doe
Copied!

If the change is related to a changelog entry, a Gerrit change, or an issue, mention it too:

Example commit message referencing a changelog issue 
[FEATURE] Add ApplicationContext to TypoScript data

Resolves: https://github.com/TYPO3-Documentation/Changelog-To-Doc/issues/790
Releases: main
Assisted-by: Claude Sonnet 5 <noreply@anthropic.com>
Signed-off-by: Jane Doe
Copied!

Format 

  • Prefix the summary line with the type of change -- [TASK], [BUGFIX] or [FEATURE] -- followed by a short, imperative summary.
  • Explain why the change is needed in the body. The diff already shows what changed; the body should cover what the diff cannot.
  • End with a Signed-off-by: Your Name trailer. Add an Assisted-by: <tool/model name> <contact> trailer too, if you used AI assistance for more than a basic spelling or grammar check.
  • If the change is related to a changelog entry, mention that changelog entry. If it is related to a Gerrit change that had no changelog entry, mention that Gerrit change instead. If it is related to an issue, mention the issue number.
  • If the manual has branches per version, add a line like Releases: main, 14.3 to note which versions your change applies to (see review policy). Backporting to those branches then happens automatically (see backport changes) -- manual backporting is only needed if the automatic backport hits a conflict or the content needs to be adjusted per version.