Commit Message Format

Michael Kinney edited this page Oct 17, 2017 · 2 revisions

This page documents our source control commit message format.

This format is also documented in Contributions.txt which may be available in the source tree as well.

Use this format for commit messages, and when providing the log message for a patch.

Commit message format

Pkg-Module: Brief-single-line-summary

Full-commit-message

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Contributor Name <contributor@email.server>

Where:

  • Pkg-Module is the EDK II Package and optionally the Module
  • Brief-single-line-summary is a short summary of the change
  • The length of 'Pkg-Module: Brief-single-line-summary' should be less than 72 characters
  • blank-line is an empty line
  • Full-commit-message is the full message describing the change
  • Line length should be less than 76 characters when possible
  • Signatures is one or more lines with signatures. Please see the Commit Signature Format page for more information.
  • The entire log message should use only standard ASCII text characters

An example would be:

Package/Module: Short one line description of change

Several lines of
description for the
change.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Contributor Name <contributor@email.server>
Reviewed-by: Reviewer Name <reviewer@reviewer-email.server>

See Also

Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.