Reporting a Bug
===============

Whenever you find a bug, we kindly ask you to report it. It helps
us make a better Superdesk Publisher.

.. caution::

    If you think you've found a security issue, please use the special
    :doc:`procedure <security>` instead.

Before submitting a bug:

* Double-check the official :doc:`documentation </index>` to see if you're not misusing the
  project;

* Ask for assistance on `StackOverflow`_ or on the official bug `tracker`_ if you're not sure if your issue is really a bug.

If your problem definitely looks like a bug, report it using the bug
`tracker`_ and follow some basic rules:

* Use the title field to clearly describe the issue;

* Describe the steps needed to reproduce the bug with short code examples
  (providing a unit test that illustrates the bug is best);

* Give as much detail as possible about your environment (OS, PHP version,
  Superdesk Publisher version, enabled extensions, ...);

* *(optional)* Attach a :doc:`patch <patches>`.

.. _StackOverflow: http://stackoverflow.com/questions/tagged/web-publisher
.. _tracker: https://dev.sourcefabric.org/projects/SWP/issues