Reporting Issues (aka Bugs ๐) or Feature Requests¶
You might be surprised to learn that we love hearing when TiXL breaks or doesn't work as expected. With an ecosystem as versatile as this, it's impossible to foresee every edge case or side effect โ so user feedback is essential to improve the software.
That said, weโre a team of volunteers working in our spare time. Remember: none of us is paid for doing this. So being kind and respectful goes a long way.
What Is an Issue?¶
You might have heard the phrase โItโs not a bug โ itโs a featureโ before. If in doubt, let us know! Weโll take a look and let you know. Even small glitches, like spelling mistakes, should be reported โ they will be promptly fixed.
How to Report Problems¶
We canโt stress this enough: itโs important to invest a bit of time when reporting. It will take at least 5 minutes to look at a report โ let alone understand or fix it โ so please take a couple of minutes and include everything you possibly can:
- Copy your system information from the Help โ About dialog.
- Use screen capture tools like OBS, Windows+G Game Bar, or ScreenToGif to record a short video and paste it into your report.
- Try to find reproducible steps.
This is the most important part: provide information that helps us understand your problem.
Before reporting, please also:
- Search all issues to see if someone else already reported something similar.
- Install the newest release to check if the problem still exists.
Where to Report¶
Ideally, create a new GitHub issue and paste all your information there. We monitor the list and respond to all reports.
For minor issues โ or if you're unsure whether โit's just youโ โ you can also ask in the #questions-and-feedback channel on Discord. Friendly people there will help you out.
Feature Requests¶
We're interested in all kinds of feedback and suggestions, such as:
- โWith this parameter of that op, I could also do that.โ
- โThis feature would be more intuitive with another name.โ
- โThis new operator would enable xyz.โ
- โI frequently use xyz in software xyz and think it could be added to TiXL.โ
As usual, the #questions-and-feedback channel on Discord is a good starting point. But you should also consider submitting a feature request on GitHub.