Reporting Bugs

Andrew Chadwick edited this page May 7, 2016 · 6 revisions
Clone this wiki locally

:rage: Something gone wrong? Report new bugs in the Issue Tracker
:rabbit: Go deeper: see Fixing Bugs
:books: This page is part of a series on how you can take part in the MyPaint project

Before reporting

  • Try to make sure the problem you're seeing really is a bug!
    A mistake installing, corrupt files, and interactions with other software can all seem like bugs in MyPaint.
  • Look in the Frequently Asked Questions (FAQ) list to see if your problem has already been reported.

How to report an issue

  1. Click on the Issues tab on the project page.

    issues tab in context

  2. Search for your issue. Somebody may already have reported it!

    Filtering and search bar

    Press Return to search the tracker. You'll see is:open in the search box by default. The is:open keyword limits the results to just open issues, so it's a good idea to remove before when searching. Your issue may already have been fixed and closed.

  3. Click the “New Issue” button, then fill in the form that appears.

  4. Fill in a good title. If you're not sure how to write a good title, use a pattern like “<feature>: <what-went-wrong-with-it>”. Avoid titles like “Problem”, or “Can't do <thing>”. The title should explain how it went wrong if possible.

  5. Fill in the body of the report in detail. Detail is good. It's important to mention quite a few things:

    Filling in the form (animated gif)

    • A brief description of the problem, expanding on what's in the title.
    • The version of MyPaint you saw the problem in, and details of your operating system.
    • The full texts of any error messages you saw.
    • Anything you tried to work around the problem.
    • Most importantly: full steps telling us how we can reproduce the problem!

    We use a template now. Hopefully all you will need to do is fill in the headed sections. :smile:

  6. Click the “Submit New Issue” button.

    Your report will then be visible to everyone looking at the issue tracker, and hopefully somebody will respond to it soon.

Reporting guidelines

When reporting a new bug,

  • Stay on topic.
    • Please limit your issue reports to a single, fixable problem.
    • Do not piggyback issue reports.
  • When reporting a bug, try to be specific.
  • Give your new report a good title, so it can be found easily in a list.
  • In the title field, explain briefly what component went wrong, and how it went wrong.
  • Make the first paragraph a concise summary without speculating too much.
  • Make sure to include detailed information which can help in pinpointing and fixing the bug.
  • Include the steps you know of to reproduce the bug.
  • Include what happens when the bug appears.
  • In-program bug reports, error messages, and strange program behaviour are all good info to provide.
  • Share what you expect to happen and what actually happens.
  • Paste in the exact version of MyPaint. Either of the following will do:
    • The long hexadecimal string from git log (looks like e0faa7f07ccdfdc43180c2b33c6a46d6f9e609fa)
    • The detailed version number pasted in from Help → About MyPaint (looks like 1.2.0-beta.3.111+git.e0faa7f)
  • Also include your operating system and its version number, and whatever other information seems related to the bug. For example, always include your tablet brand and model name/number when reporting a problem with input handling.
  • A picture is often worth a thousand words - and a screencap can be dragged into a report for us to look at.

Here's an example of a helpful bug report from our old tracker.

If you are requesting a new feature, please submit mockups, pictures, or other clear explanations of what it is you want. And please tell us how the feature would help you.

How we'll handle your bugs

:link: See also Answering Issues

The tracker is not really intended for user support, but we can sometimes help investigate your problems there. Your problem report may turn into a workaround you can use, and many reports have helped us uncover a more fundamental bug in the program code. However don't be discouraged if the issue gets closed when there's nothing we can do about it in the current phase of development. You may find that the MyPaint Community Forums are a better place to ask in many cases.

Please report bugs against the newest version of MyPaint you can find. MyPaint 1.0.0 is not supported. If you are on Windows, much more up-to-date builds are available:

See Also