Using the issue tracker

The issue tracker is the preferred channel for bug reports and features requests, but please respect the following restriction:

Bug reports

A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful, so thanks!

Guidelines for bug reports:

  1. Validate your code — ensure your problem isn't caused by a simple error in your own code.

  2. Use the GitHub issue search — check if the issue has already been reported.

  3. Check if the issue has been fixed — try to reproduce it using the latest develop branch in the repository.

  4. Isolate the problem — ideally create a reduced test case and a live example.

Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue?


Short and descriptive example bug report title

A summary of the issue and the Python/OS environment in which it occurs. If suitable, include the steps required to reproduce the bug.

  1. This is the first step
  2. This is the second step
  3. Further steps, etc.

Any other information you want to share that is relevant to the issue being reported. This might include the lines of code that you have identified as causing the bug, and potential solutions (and your opinions on their merits).

Feature requests

Before opening a feature request, please take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.

Pull requests

For legal reasons we're currently not accepting pull requests. Please create an issue if you have suggestions for improvements.