Report a bug
If you encounter any bugs or issues with the Decentraland SDK and the Editor, please report them on our GitHub repository here .
Before you report a bug #
Before submitting a bug report, please ensure the following:
- Ensure you’re using the latest version of the SDK, in case the issue has already been fixed in newer releases.
- Check the documentation for the feature you’re trying to use, to confirm that it’s supposed to behave as you’re expecting, and that this is not just a misunderstanding.
- Rule out that the problem could be caused by how your scene is built. See Debug in Preview and Debug in Prod for tips.
- Avoid duplicates. Check the list of known bugs to avoid making a duplicate. If you have more information to add to an existing issue, please add a comment to the issue rather than creating a new issue.
Reporting a bug #
To report a bug with the SDK, you’ll need a GitHub account. Follow these steps:
Visit the following link: New Issue Page
Click Get Started next to Bug Report.
Complete all the fields in the template. The template provides instructions for each section. The more details you can provide, the quicker our developers can identify and resolve the issue.
Click Submit new issue.
Developers may ask follow-up questions on your ticket if they need clarifications or additional information. You’ll receive email notifications of updates to your bug report.
📔 Note: For any issues not related to the SDK please contact the support team. To reach out, please visit this page intercom.decentraland.org or send us an email to [email protected] . You can also find us on Discord . The team is available to help out from Monday-Sunday, 12pm to 9pm UTC and will do its best to get back in touch as soon as possible. You can expect a reply within 60 min on Discord during the above time frame and within 24h on email.
Additional Tips for Bug Reports:
- Create a separate issue for each bug. If you encounter multiple issues, make sure to create a new issue for each one.
- Avoid lengthy explanations. Only include relevant command-line or console output or scene code when necessary.
- Attach images or videos if possible. You can easily drag and drop them into the issue text area, and GitHub will handle the upload and linking.
Using the Decentraland Playground #
Providing code snippets that demonstrate the problem is extremely useful. Reproducibility is crucial. If a bug can’t be reproduced, it’s challenging to diagnose and fix.
You can paste code snippets within your issue text, but the best way to provide code snippets is by using the Decentraland Playground . Follow these steps:
Write your code snippet on the left, and view your scene on the right panel.
Click the Share button and paste the link into your issue report.
Using the playground simplifies issue reproduction and ensures that anyone opening the link can see the same output, regardless of their operating system, SDK version, Node version, etc. It also facilitates quick iteration to identify affected conditions and pinpoint the issue’s cause.
Keep your example as concise as possible, while still reproducing the issue. A simpler example helps eliminate ambiguity about the problem’s source.
📔 Note: It’s not possible to import assets to your scene on the Playground. So if reproducing the issue requires importing a 3D model or a sound file, it won’t be possible to display there.
Editing Documentation #
If you discover issues in the content of the Documentation website, you can submit change requests. Simply scroll down to the bottom of the page and click the Edit this page button. GitHub will guide you through creating a pull request with your changes. The foundation team will review your changes and publish them if they’re deemed useful.
Feature Requests and Suggestions #
If you have suggestions for adding new functionality or features rather than reporting a problem, please use Decentraland’s Canny board instead of creating a GitHub Issue.