How to report a bug

Where to report a bug

The Adventure PHP Framework uses as central Issue Management Tool (Tracker) that contains all bugs and features. Defects should thus be reported to the Tracker directly. In case you do not have an account, please sign up first. Afterwards, you can create a new entry.

Search the existing bug reports first!

Read the documentation carefully and always search the bug database first. This avoids duplicate bug reports and helps us to save time spent on analyzing duplicate reports.

Try the current SVN version

If applicable, please try to use a current version from the SVN. Probably, the bug has already been fixed. For detailed instructions on how to obtain a copy from the svn, please refer to GIT repository.

The basics: what you did, what you wanted to happen, and what actually happened.

Those three elements are the basics for all bug reports. It is important to tell us, what you have tried to do (e.g. include taglib within a template) and what actually happened (e.g. taglib was not executed). The better the description, the faster the problem could be analyzed and a bug fix could be created.

What must be included in a bug report

A good bug report contains the following parts:

  • A summary of the actual problem to give information about the context of your work.
  • A couple of sentences describing, what you did, what you wanted to happen, and what actually happened.
  • A code sample enabling a developer to reproduce the bug.

In case, these things are present, we are sure to be able to provide a quick bug fix - in case it is a true bug. ;)