How To Report a Bug
Closed, ResolvedPublic


How to Report Bugs

Bugs can be reported to [ KDE's bug tracker]. The bug tracker is a tool for Krita's developers to help them manage bugs in the software, prioritize them and plan fixes. It is not a place to get user support!

The bug tracker contains two kinds of reports: bugs and wishes. Bugs are errors in Krita's code that interrupt using Krita. Wishes are feature requests: the reporder thinks some functionality is missing or would be cool to have.

Do not just create a feature request in the bug tracker: follow Feature Requests to learn how to create a good feature request.

This guide will help you create a good bug report. If you take the time to create a good bug report, you have a much better chance of getting a developer to work on the issue. If there is not enough information to work with, or if the bug report is unreadable, a developer will not be able to understand and fix the issue.

Only Report Bugs

A bug is a problem in Krita's code.

  • If you have problems with your drawing tablet, for instance no support for pressure, then that is unlikely to be a problem in Krita's code: it is almost certain to be a problem with your setup or the driver for your tablet.
  • If you've lost the toolbox, or if you have deleted your work, that is not a bug.
  • If Krita works differently from another application, that's not a bug.
  • If Krita works differently than you expected, that's not a bug.
  • If Krita is slower than you expected, that's not a bug.
  • If Krita crashes, that's a bug.
  • If a file you save comes out garbled, that's a bug.
  • If Krita stops working, that's a bug.
  • If Krita stops displaying correctly, that's a bug.

Check the FAQ

If you've got a problem with Krita, first check the [ FAQ]. See whether your problem is mentioned there. If it is, apply the solution. If that doesn't work for you, do not report a bug. Ask for help on Krita's [ Forum].

If uncertain, ask on Krita's chat channel or the forum. Krita's chat channel is maintained on Developers and users hang out to discuss Krita's development and help people who have questions.

  • Note: most people live in Europe, and the channel is very quiet when it's night in Europe.
  • You also have to patient: it may take some time for people to notice your question even if they are awake.
  • Krita does not have a paid support staff. You will chat with volunteers, users and developers. It's not a help desk.

But you can still ask your question, and the people in the channel are a friendly and helpful lot.

Use the Latest Version of Krita

Check Krita's website to see whether you are using the latest version of Krita. There are two "latest" versions:

Check for Duplicates

This can be tricky: many bug reports are very unclear, have misleading subjects are are assigned to the wrong component. The Krita team tries to triage incoming bugs, fixing the subject, the component and asking for more information in case the bug is not clear.

But please do try to check whether a problem has already been reported. If it is, please add your report as a comment to that bug ticket.

Be Complete and Completely Clear

Give all information. That means that you should give information about your operating system, hardware, the version of Krita you're using and, of course about the problem.

  • Operating system: fill in the requisite field in the bug tracker's form
  • Version: fill in the requisite field in the bug tracker's form
  • Hardware information: copy the information from Krita/Help/System information for bug reports into your report.
  • If you are using a drawing tablet, tell us the brand and type.
  • Tell us what kind of image you were working on: the size, the resolution, the color model and channel depth.
  • If you are reporting a crash, attach a [XXX crash log]. Follow the link to learn how to get a crash log.

The problem needs to be clearly stated: what happened, what had you expected to happen instead and what can be done to reproduce the problem. Give a concise and short description, then enumerate the steps needed to reproduce the problem. If you cannot reproduce the problem, and it isn't a crash, think twice before making the report: the developers likely cannot reproduce it either.

If at all possible, attach your original Krita file (the one that ends in .kra) to the bug report, or if it's too big, add a link for download. If you do that, make sure the file will be there for '''years''' to come: do not remove it.

If you think it would be useful, you can also attach or link to a video. Note that the Krita developers and bug triagers are extremely busy, and that it takes less time to read a good description and a set of steps to reproduce than it takes to wach a video for clues for what is going on.

When making a video or a screenshot, include the whole Krita windows, including the titlebar and the statusbar.

XXX: Screenshot of a good bug; link to this example bug.

You're not done after you've filed the report.

After you have filed your bug, mail will be sent out to all Krita developers and bug triagers. You do not have to go to the chat channel and tell us you created a bug.

When a developer decides to investigate your report, they will start adding comments to the bug. There might be additional questions: please answer them as soon as possible.

When the developer has come to a conclusion, they will '''resolve''' the bug. That is done by changing the resolution status in the bug tracker. These statuses are phrased in developer speak, that is to say, they might sound quite rude to you. There's nothing that we can do about that, so do not take it personally. These are the most used statuses:

  • Unconfirmed: your bug has not been investigated yet, or nobody can reproduce your bug.
  • Confirmed: your bug is a bug, but there is no solution yet.
  • Assigned: your bug is a bug, someone is going to work on it. There probably will be a corresponding task on the developer workboard.
  • Resolved/Fixed: your bug was a genuine problem in Krita's code. The developer has fixed the issue and the solution will be in the next release.
  • Duplicate: your bug has been reported before
  • Needinfo/WaitingForInfo. You need to provide more information. If you do not reply within a reasonable amount of time the bug will be closed.
  • Resolved/Invalid: your report was not about a bug.
  • Resolved/Upstream: the issue you observed is because of a bug in a library Krita uses, or a hardware driver, or your operating system. We cannot do anything about it.
  • Resolved/Downstream: Only on Linux. The issue you observed happens because your Linux distribution packages Krita in a way that causes problems.

Related Objects

rempt created this task.Nov 26 2017, 10:36 AM

I tried to explain this problem to someone who isn't technically inclined, and they said that it might be an idea to encourage people to go to the forum if they are not sure if it is a bug. It will increase the amount of forum posts, but directing them from there to the bugtracker might be a little easier than to get them to stop asking help questions on the bugtracker...

woltherav removed a parent task: Restricted Maniphest Task.Jan 1 2018, 10:56 AM
rempt updated the task description. (Show Details)Jan 15 2018, 1:39 PM
rempt updated the task description. (Show Details)Mar 13 2018, 8:58 AM
rempt closed this task as Resolved.Jul 16 2018, 7:40 AM
rempt reopened this task as Open.
rempt closed this task as Resolved.Aug 13 2018, 9:22 AM