This page assumes you'd like to contribute to the Krita project by collecting enough information to enter a useful bug report in Krita bug tracking system. Thank you! You can also get assistance in the #krita channel on irc.freenode.net.

1. Bug report checklist

  1. Figure out the steps to reproduce a bug.
  2. Make sure your software is up to date. Ideally, test an in-development version to see whether your bug has already been fixed (e.g. Krita Lime, openSUSE, or Arch packages)

  3. Try to reset your Krita configuration files and brush presets.

After information is gathered, report the bug:

  1. Open a new bug report for each issue!
  2. Write a clear summary for each bug report

  3. Write your operating system. Windows or Linux? If Linux, how did you install Krita: official distribution packages, Krita Lime or you built manually using Krita for Cats tutorial?
  4. Write a version of your package.

  5. Provide precise steps to reproduce this bug

  6. Provide additional information if your bug is a crash, hangup, tablet related, memory consumption or performance related bug.

2. Writing a clear summary

3. Finding out a version of Krita package

4. Writing precise steps to reproduce

How can a developer reproduce the bug on his or her own computer?

Steps to reproduce are the most important part of any bug report. If a developer is able to reproduce the bug, the bug is very likely to be fixed. If the steps are unclear, it might not even be possible to know whether the bug has been fixed.

5. Providing additional information

5.1. Crash Bug

When experiencing a crash, attach a backtrace information to the bugreport if possible.

5.2. Hangup Bug

When a hangup occurs you should generate a backtrace manually using gdb. Please use Crash Bug for the info.

When reporting a table-related bug, make sure you attach a tablet event log, which shows developers how your tablet communicates with Krita.

5.3.1. Common

5.3.2. Windows

  1. Install DebugView from the official Microsoft website

  2. Start DebugView

  3. Start Krita

  4. Press Ctrl+Shift+T, you will see a message box telling the logging is started

  5. Try to reproduce your problem
  6. Go back to DebugView and save its output to a file. Attach this file to a bug report or paste using services like paste.kde.org

5.3.3. Linux

  1. Open a console application (e.g. konsole in KDE)

  2. Set the amount of scrollback to 'unlimited' (for Konsole: Settings->Edit Current Profile->Scrolling->Unlimited Scrollback)

  3. Start Krita by typing krita and create any document.

  4. Press Ctrl+Shift+T, you will see a message box telling the logging is started

  5. Try to reproduce your problem
  6. The console is now filled with the log. Attach it to a bug report as a file or paste using services like paste.kde.org

5.4. Memory consumption bug

Provide the following information about your configuration:

5.5. Painting performance bug

Provide the following information about your configuration:

6. OpenGL bugs

  1. If on Windows install DebugView from the official Microsoft website and start it

  2. Open Krita
  3. Go to Preferences->Performance->Enable OpenGL logging

  4. Restart Krita
  5. Do many long strokes for about a minute

  6. You should get many new messages in DebugView or in the console

  7. Paste the messages to any service like paste.kde.org and attach it to the bugreport

krita/BugWritingGuidelines (last edited 2016-04-27 15:07:18 by broadband-90-154-71-21)