Child pages
  • How to write a commit message

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

When you contribute code to the PrestaShop project (through Github), we ask that you strictly use the PrestaShop way of writing a commit/pull request message. This way, when building the code history, your commit message will fit nicely with the ones from the PrestaShop developers and contributors.

Table of Contents

...

Commit naming convention

The commit/PR's title name must be in English, and should be formatted like this:

Code Block
[type] category : short description

The title of the pull request should be the same as its commit, and must follow the same convention.

If the pull request has several commits, the title of the pull request should either use the name of the most important commit, or should reflect the overall change of the pull request.

Type

The type is the general idea behind your commit: are you fixing a bug, making an improvement, etc.?

...