Contribution guidelines for modules

This document describes general guidelines for contributing to PrestaShop modules hosted on GitHub.

How to contribute

Contributors wishing to edit a module’s files should follow the following process:

  1. Create your GitHub account, if you do not have one already.
  2. Fork the project to your GitHub account.
  3. Clone your fork to your local machine in the /modules directory of your PrestaShop installation.
  4. Create a branch in your local clone of the module for your changes.
  5. Change the files in your branch.
  • Be sure to follow the coding standards.
  • Do not update the module’s version number.
  1. Push your changed branch to your fork in your GitHub account.
  2. Create a pull request for your changes on the dev branch of the module’s project. Make sure to describe your change as best as you can: a good description can help a lot on making your contribution accepted.
    If you need help to make a pull request, read the GitHub help page about creating pull requests.
  3. Wait for one of the module maintainers either to include your change in the codebase, or to comment on possible improvements you should make to your code.



Unless specified otherwise, PrestaShop modules are released under the Academic Free License 3.0. All contributions made to those modules are automatically licensed under the same terms.

A license file must be stored inside the module (usually it’s a file). Its content is the terms of the AFL-3.0 license.

File headers

All files within a module must include the AFL license header, as provided in the coding standards chapter.

They can easily be applied by using the header-stamp binary from PrestaShop modules developer tools.

Contributors file

A list of the project contributors must be stored inside the module. Usually it’s a file named . It must be up-to-date when a new version is released.