Reporting Issues
Found a bug or have a request? Here's how to create a GitHub account and file an issue so the team can help.
The best way to report a bug, ask for a feature, or flag something confusing is to open an issue on GitHub. Issues are public, searchable, and let the team track and respond to your report. You don't need to be a developer β this page walks you through it from scratch.
Create a GitHub account
If you don't already have one, you'll need a free GitHub account.
Go to the sign-up page
Open github.com/signup in your browser.
Enter your details
Provide an email address, a password, and a username. GitHub will send a code to your email to confirm it's really you.
Verify and finish
Enter the code from your email. That's it β you now have a GitHub account and can create issues.
Already have an account?
Just sign in and skip to the next section.
File an issue
Open the issues page
Go to the project's issue tracker: github.com/unicef/adt-studio/issues.
Search first
Type a few keywords into the search box to check whether someone has already reported the same thing. If you find a matching issue, add a comment or a π reaction instead of opening a duplicate β it helps the team gauge how many people are affected.
Choose a template
Click the green New issue button. You'll be asked to pick the template that matches what you're reporting β choose the closest one:
- Bug Report β something isn't working the way it should.
- Feature Request β suggest a new feature or improvement.
- Accessibility Issue β report an accessibility barrier in the app or in a book it produced.
- Documentation Issue β something in these docs is wrong, unclear, or missing.
- Question / Support β ask how to do something in ADT Studio.
Fill in the form
Each template is a short form that asks for exactly what the team needs, so just follow the fields. A few tips for a report that's quick to act on:
- A clear title β summarize it in one line (e.g. "Audio fails to generate for Portuguese").
- What happened vs. what you expected.
- Steps to reproduce it β what you clicked, in order, so the team can see it too.
- Your setup β your operating system (Windows, macOS, or Linux) and the ADT Studio version.
- Screenshots or a screen recording β drag image files straight into the text box. A picture often explains more than a paragraph.
Submit
Click Submit new issue. You'll get an email whenever someone responds, and you can reply right from your inbox or on the issue page.
Don't include sensitive information
Issues are public. Never paste passwords, API keys, or personal data into an issue β blur or remove them from screenshots first.