.. _bug_reporting:

Bug Reporting
################

Although |popy| undergoes thorough tests before release, it is always possible
that there will be cases we have not considered that cause |popy| to fail.
(|popy| scripts contain a lot of "free text" where the user defines their own
model with few constraints.) 
If you do come across something you believe is a bug in the software, please
report it to us so that we can fix it make |popy| the best it can be.

Bug Reporting Procedure
========================

1. Check you have a genuine bug and that you are using the latest version of |popy|. 
2. Write down the steps that reproduce the bug so that we can recreate it at |popy| HQ. Include as many details as possible, including operating system and |popy| version. Feel free to share your log files and input scripts with us but *please remove anything sensitive*. A minimal ``tut`` script that reproduces the bug without using real data is perfect for reporting bugs.
3. Write down what you expected to happen and what actually did happen.
4. Email your bug report to |email|. (|popy| does not yet have a formal bug tracking system but may do in the near future.)

If we can't reproduce the bug, we will contact you 
to try to get to the bottom of the problem.
Once we can reproduce the bug, we will endeavour to give you
a time estimate of how long it will take to fix and, 
if the bug is serious, will release a new |popy| binary as soon as it is fixed.
If the bug is relatively minor, the fix will be available in the next scheduled 
|popy| release.
