Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify commit summary text for non-issue related commits #6586

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Clarify commit summary text for non-issue related commits #6586

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a2e1320
Clarify commit summary text for non-issue related commits
xdje42 Jan 25, 2024
1a9d0aa
Merge branch 'master' into iX-doc-iX-commits
xdje42 Jan 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion api/docs/code_reviews.dox
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,16 @@ can select a particular reviewer if desired.

xdje42 marked this conversation as resolved.
Show resolved Hide resolved
\section sec_commit_messages Commit Messages

Commit messages should include an initial title line separated from the body of the message by a blank line. The title line should be a concise summary and should start with the issue number followed by a colon which is followed by the description of the issue fix. If the issue is fixed by more than one commit, the title should instead start with the issue number followed by a space and a short issue description, then a colon, and then a description of this particular fix, with a reference to the issue at the bottom for automatic linking in Github. In either case, the body of the message should elaborate on the contents of the commit using complete sentences.
Commit messages should include an initial title line separated from the body of
the message by a blank line. The title line should be a concise summary and
should start with the issue number followed by a colon which is followed by the
description of the issue fix. If there is no issue just write the summary,
don't prefix it with, e.g., "iX:". If the issue is fixed by more than one
commit, the title should instead start with the issue number followed by a
space and a short issue description, then a colon, and then a description of
this particular fix, with a reference to the issue at the bottom for automatic
linking in Github. In either case, the body of the message should elaborate
on the contents of the commit using complete sentences.

For a commit that fixes an Issue, be sure to resolve the Issue with a
message indicating the commit revision number. If you use the exact string
Expand Down
Loading