Search Unity

Attaching your project to a bug report

August 24, 2016 in Community | 3 min. read
image06
image06
Topics covered
Share

We want your bug reports!

With good reports, we can get the info we need to improve the quality of Unity for everybody. When your bug reports include a solid description and an attached project, we have a 3 times larger chance of reproducing the issue and filing a bug that can be fixed! But a lot of you are having problems attaching larger projects. This post shows three different ways you can get around that issue.

The bug reporter is accessible through the Unity Editor. Here’s a brief outline of what an ideal bug report includes:

  1. A project which reproduces the issue.
  2. Steps needed to reproduce the issue.
  3. Actual vs expected behavior.

If you report with the latest version of Unity, we’ll be able to verify right away that the issue hasn't been fixed in newer versions. Currently, that would be Unity 5.4, until 5.5 is publicly available. You can also search for duplicates on the Issue Tracker. Voting on issues increases their priority.

image06

Attaching additional folders or files

Your project is attached to the bug report by default unless you remove it manually. There are buttons on bottom left corner to add files and folders. Attaching images or screen recordings can be very helpful. If you are having issues with size, then you should try using stripping tools to delete unused files and attach the stripped project.

image07

Repro Project wizard

This tool creates a new project with specified assets and includes dependencies. Textures can be downscaled to reduce size. Use case scenario would be to make a smaller repro scene inside your project and then export it using this tool.

  • After the package imports and the code finishes compiling, go to Window->Repro Project Wizard. You should see the following window open:
image03
  • Add a scene that shows the issue you want to include in your Repro Project to the Asset list at the top of the window.
  • (optional) If your code loads assets from the resources folder, please include them separately.
  • Select a path for the new project in the Project Path field.
  • If image quality isn’t relevant to your issue, you can choose to downscale textures to reduce the new project size.
  • Hit Create Project.
image05

Stripping tools

Let’s you select folders or specific types of assets and strip them out. All changes can be reverted back. We highly recommend using using cache server to improve importing times after reverting changes.

This content is hosted by a third party provider that does not allow video views without acceptance of Targeting Cookies. Please set your cookie preferences for Targeting Cookies to yes if you wish to view videos from these providers.

  • Make a copy of your project or create a new one with Repro Project tool.
  • Download and import Stripping tools package (wait for importing and code compilation to end)
  • Right click on any folder or asset in your Project browser window
  • You get a variety of options: image01 image00First five options are selection wide and last two are scene view dependant.
  • If at some point you want to revert changes then select ProjectStrippingSession.asset inside your Assets folder.image02
  • Select the step from “Stripping steps performed” and click Undo selected operation. After selection you will see the asset list which were affected by the step.

Conclusion

All of us in the QA team love bug reports that are short and go straight to the point. They really help us pin down your problems faster. When we can quickly check your project to see the difference between expected and actual behaviour, even better. We hope this post has helped you see that attaching your project to a report is not as hard as it sometimes seems. If your project is huge, you can use the stripping tools and delete folders that are not needed. That should help to reduce the size a lot. Let us know in the comments if you have found other bug reporting tricks!

August 24, 2016 in Community | 3 min. read
Topics covered