Feature Requests and Bug Reports
We love to hear from our users! The Surge project has been able to attain the quality it has today thanks to a dedicated group of musicians who gave patient and clear feedback on bugs and brainstormed ideas for new and improved features. We invite you to share your feedback too.
And good bug reports make good software! So please feel free to open a GitHub issue! But there are some guidelines which may help.
Good GitHub issues should have clear titles (like “Mouse doesn’t map properly to filter section when modulating”, not “Bug”). They should contain some key information:
- Include the full version information for your version of Surge. This can be found in ‘menu/about’ and includes the OS, host style, and version. For instance “Windows 64 bit VST3, Surge 126.96.36.199”
- Include the full information about your operating system. For instance “MacOS 10.13.4” or “Unbuntu 18.04 LTS”
- Include the information about your host. This is especially important since there are lot of hosts and we may not heard of yours. If you can get a trial version of your host letting us know is nice also.
And once all of that is included, please include a clear description of the bug. How you demonstrate it and what you expect. Screenshots help, but clear text is good also.
Here’s a great bug report:
“Surge Windows 10 VST3 version 188.8.131.52 in FL Studio 20. When I am dragging a slider in modulation mode, if I drag off the end of the slider and keep dragging, the modulation slider can reset to the max. Unmodulated the slider doesn’t do that”
That’s a real bug report we got. It was a one line fix once we had that clear description!
For features, be more creative. We love to hear ideas.
And we try to fix bugs in a timely fashion. But as always, the best bug is one which comes with a pull request to fix it. Dive in! The code’s not that scary.
The Surge Developers