Skip to content

Reporting issues

jspijker edited this page Feb 9, 2023 · 4 revisions

In order to help the developers of Cura debug and fix issues, we kindly ask reporters to follow some simple guidelines.

Before creating an issue, make sure that:

  • The issue doesn't already exist. This can be done by looking at the pinned issues and by performing some searches in the Issue List.
  • That the issue you are reporting is a technical issue. Problems setting up your printer or problems with any other products than Cura will not be answered here.

Issue Template

The template used for bug reports can be found on https://github.com/Ultimaker/Cura/issues/new/choose We kindly request you to use this template and fill it out entirely. If any part of this is skipped, it is likely to decrease the chances of your issue getting fixed.

Title

Please note the application version in the title of the issue. For example: "[3.2.1] Cannot connect to 3rd-party printer". Please do NOT write things like "Request:" or "[BUG]" in the title; this is what labels are for.

When selecting a title, try to create an as descriptive title as possible. This makes it easier for others to understand what the issue is about and reference it in other issues.

Examples

Bad

  • "Cura Crashes"
  • "I found a bug!"
  • "It doesn't work!"

Good

  • "[4.7.0] Profiles missing and cannot be created"

Application version

The version of the application this issue occurs with.

When running Cura from a not supported source (everything that isn't distributed by UltiMaker), include this as well.

Platform

Information about the operating system the issue occurs on. Include at least:

  • Operating system type
  • Operating system version
  • GPU (and what drivers are installed)

Printer

Which printer was selected in Cura? Does it happen with all printers?

Reproduction steps

The reproduction steps are probably the most important bit of the issue report. The easier it is for the developers to reproduce the issue, the more likely it is that your issue is fixed. Ensure that these steps are as simple as possible, all the while ensuring that it completely reproduces the issue.

If the issue has no guaranteed reproduction steps because it doesn't always reproduce, make sure to mention this as well.

In some cases it can help to add videos / screenshots showing the problem.

Expected results

When you followed the steps described in the previous step, what did you think would happen?

This step is there to figure out if the issue is a technical or a UI/UX issue. Sometimes the behavior of the application is intended, but just not clear to the user. Knowing which is which makes it a lot easier to resolve the issue.

Actual results

What happend when you did the reproduction steps? Note that this must always be different from the expected results.

Project file

In all cases related to slicing issues and configuration issues attach a project file saved from cura. This makes it significantly easier to check what is going on and to reproduce it.

Are you unable to share the file publicly? Mention this in the issue and we will provide you with a way to share the project file with us privately.

Log file

The log file is one of the best ways to figure out what is going on. See https://github.com/Ultimaker/Cura#logging-issues to find the log file to upload.

Clone this wiki locally