Report a Bug / Request a Feature¶
Like most other pieces of software, Inkscape has plenty of bugs and crashes from time to time. However thanks to the open-source nature, you can help it get fixed by reporting the bug. You can also make a request for a feature you want to see in Inkscape.
Note
Inkscape uses Gitlab for issue tracking. Before starting the process, plase make sure that you have created a Gitlab account and are logged in.
Before Filing a New Report¶
Before you file a new bug report:
Todo
Add link to preference reset
Please make sure you can reproduce the bug and identify the necessary steps to trigger it.
You can start with a blank or saved file, and make notes of the minimal number of steps used to trigger the bug or crash. Please also take note of any setting that needs to be enabled or disabled to reproduce the bug. If possible (or asked by the bug triager), you can rename the preferences folder to try reproducing the bug with fresh settings.
Search the issue tracker on Gitlab:
Open the inbox (https://gitlab.com/inkscape/inbox/-/issues/). This is the place to report issues before bug triagers move them to more appropriate places.
Switch to the All tab.
Search for your issue in the search box.
If an existing issue is closed, it could mean one of three things:
The bug has been resolved.
The bug has been confirmed and moved to the main issue tracker, but it is not resolved yet.
The bug is a duplicate, not a bug, or invalid in one way or another.
Discuss the bug with the community.
It is possible that the bug should be a feature request, has workarounds, or has been reported in some other way. You can ask the community to see if that is the case before reporting. Community members may also help you with reporting if you’re a beginner or haven’t reported bugs before.
If a report of the same bug (or request for the same feature) already exists, you can add a comment with potentially helpful information. If the report is in the inbox, you can also comment to confirm the issue, as that would make it qualified to move to the main tracker. If it’s in the main tracker instead, you can upvote it by clicking on the thumbs-up 👍 button in the issue page below the description.
Information in the Report¶
Bug Reports¶
Each bug report should contain the following information:
A precise description of the problem that contains as many details as possible, including:
Step-by-step instructions that reliably reproduce the issue.
Actual program behavior.
Expected program behavior.
Information about your Inkscape installation as described in the chapter View and Copy System Information.
All of the above are present in the default template when you create a new issue. Simply fill in the information in the specific locations.
In addition, you can include the following information to help with debugging:
A minimal example, which is a SVG file that contains everything needed to reproduce the bug but nothing else.
The same file in another format if the bug is related to opening, importing from or exporting to a file format other than SVG.
Screenshots, videos or animations that demonstrate the problem.
The language of the Inkscape interface if the bug is related to encoding or translation problems.
The method of installation if the bug is related to installing, updating or uninstalling Inkscape.
Feature Requests¶
If you are about to open a feature request, please include the following information:
A description of the feature you envision. Please include as much detail as possible.
Who or which workflows it will benefit, and how so.
Information about your Inkscape installation as described in the chapter View and Copy System Information.
If possible, please also include:
Screenshots, videos or links to manuals if the feature is included in other software.
A mockup of the interface if it needs additions to the GUI.
A interaction diagram to demonstrate specific workflows.
Why This Information is Important¶
Why is all this information important?
Because developers must be able to reproduce a problem before they can begin to fix it. In Inkscape, bugs can be specific to certain versions or certain operating systems (as well as certain combinations of those) or occasionally certain languages. While a test file is not strictly required, or not always appropriate or needed, anything bug reporters do can help make it easier for developers to help.
Most Inkscape developers are volunteers. They work on Inkscape in their spare time, after their workday, playtime, family time, and personal time. Everything bug reporters can do to make it easy and save time will increase the likelihood that the bug will be fixed.
Reporting¶
To create a report: (assuming you are logged in to Gitlab)
Open the inbox (https://gitlab.com/inkscape/inbox/-/issues/) in a web browser. Please report new issues here and not in the main tracker.
Click on the New Issue button.
Enter the title and the issue description as instructed above.
Click on Create issue at the bottom of the page.
After Reporting¶
After you created the report:
Remain available to respond to developers requests about your report.
You’ll receive an email notification whenever someone posts a comment, or simply changes the category, ranking or rating about the bug report. You may be asked to clarify something, or to provide other files, images or documentation. Please remember that everything you can do to help developers will increase the likelihood of a successful fix.
Be patient and remain positive. When you report a bug, you are doing so because you want the bug fixed. We want the same! As Inkscape is developed by volunteers in their spare time it might take a while before somebody gets to your report (anywhere between hours and years). In any case try to be as kind and as helpful as possible (even at times when the developers might seem a bit dull from your perspective 😉) as people will usually be more motivated to work on the bug, and the problem will get fixed faster.
Note
If you want to help with bug triaging instead, please read the Bug Wrangler’s Guide in the Inkscape Gitlab.