Skip to content

Commit 540211b

Browse files
[TASK] Language checks
Releases:main
1 parent cb88081 commit 540211b

1 file changed

Lines changed: 13 additions & 12 deletions

File tree

Documentation/Howto/EditLocal.rst

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -102,25 +102,26 @@ the ability to experiment and preview your changes locally before submitting the
102102
`[BUGFIX]` or `[FEATURE]` -- followed by a short, imperative summary,
103103
for example `[TASK] Document anchor persistence rule`.
104104

105-
Explain *why* the change is needed in the body. The diff already shows
106-
what changed; the body should cover what the diff cannot.
105+
Explain *why* the change is needed in the body of the commit. The diff
106+
already shows what has changed. The commit body should cover what the diff
107+
cannot.
107108

108-
End with a `Signed-off-by: Your Name` trailer. If you used AI assistance
109-
for more than a basic spelling or grammar check, add an
109+
End with a `Signed-off-by: Your Name` trailer. If you have used AI assistance
110+
for more than basic spelling or grammar checks, add an
110111
`Assisted-by: <tool/model name> <contact>` trailer as well.
111112

112-
If the change is related to a changelog entry, mention that changelog
113-
entry. If it is related to a Gerrit change that had no changelog entry,
114-
mention that Gerrit change instead. If it is related to an issue,
113+
If the change is related to a changelog entry, mention the changelog
114+
entry. If it is related to a Gerrit change that does not have a changelog
115+
entry, mention the Gerrit change instead. If it is related to an issue,
115116
mention the issue number. See :ref:`howto-update-docs-commit-messages`
116117
for an example.
117118

118-
If the manual has branches per version, add a line like
119-
`Releases: main, 14.3` to note which versions your change applies to
120-
(see :ref:`review-policy`). Backporting to those branches then happens
121-
automatically (see :ref:`backport-changes`) -- manual backporting is
119+
If the manual has version branches, add a line like
120+
`Releases: main, 14.3` to note which version branches your change applies to
121+
(see :ref:`review-policy`). Backporting to these branches will then happen
122+
automatically (see :ref:`backport-changes`). Manual backporting is
122123
only needed if the automatic backport hits a conflict or the content
123-
needs to be adjusted per version.
124+
needs to be changed for a version.
124125

125126
9. Push changes
126127

0 commit comments

Comments
 (0)