Notice: You are browsing the documentation for PrestaShop 8, which is currently in development.

You might want to read the documentation for the current version, PrestaShop 1.7.

How to use GitHub to report an issue

PrestaShop uses GitHub to track bugs and issues. This is the best place to report the bugs you are witnessing on your PrestaShop shop.

You need a free GitHub account to collaborate. If you don’t have one yet, you can create it here.

Creating an issue

To create your first issue, go to the list of issues and click on the “New issue” button on the right. Or just click here.

Issue or Feature request

Choose between a “Bug report”, or a “Feature request”, and click on “Get started”

Issue or Feature request

A text editor appears:

Issue or Feature request

To fill the required information, just use the text editor. You can use the “preview” tab to see how your issue will be published.

There are five main sections:

  1. Describe the bug – a clear and concise description of what went wrong.
  2. Expected behavior – describe what you expected to happen instead.
  3. Steps to Reproduce – describe the different steps and information to reproduce the issue.
  4. Screenshots – add screenshots in this section.
  5. Additional information – like your version of PHP and MySQL, as well as any other relevant server configuration.

Click the “Submit new issue” button when you are done.

Best practices for writing an issue

When writing a bug report, please use these guidelines:

  • Make sure you can reproduce your bug every time.
  • Make sure your software is up to date.
  • Ideally, test the latest nightly build development version to see whether your bug has already been fixed.
  • Search in GitHub issues to see whether your bug has already been reported.
  • Write a clear summary. Describe the observed result what you expected to happen instead.
  • Write precise steps to reproduce. Be specific and verbose: do not fear to give details on how you did reproduce the bug.

These are inspired by Mozilla’s own guidelines.

GitHub provides very good documentation about how to write issues with its flavoured Markdown. It is possible to highlight code syntax, add pictures, or even to link issues and pull requests.

What happens after you submit your issue

If your issue can be reproduced using a clean install, it is likely that the problem effectively is due to a software defect. In that case, the bug will receive a severity classification, and be added to the backlog so that it can be fixed in a future release.

To find out more, read How issues are sorted.