-
Notifications
You must be signed in to change notification settings - Fork 115
Reporting Bugs
Bug reports are always welcome. That said, they come in useful and less useful flavors. A quick glance at the summary line often suffices to make a good guess. These are examples of unactionable bug descriptions:
- Nothing works
- Vintageous broke everything in my life
- 2.9 ruined my marriage
- The end is nigh
You get the idea. Assertions like that are vague and — even if they were true — they don't help diagnose the issue. If you are taking the time to write a bug report because you want a problem fixed, make an effort to provide as much useful information as possible.
Similarly, if you're posting a feature request, try to link to the relevant Vim documentation pages.
Vintageous will be at fault many times and severly so, but a poor bug report won't improve the situation.
Here's a few tips on writing useful bug reports — if you're in the mood:
Vintageous is open source. If you hit a bug, you can send a pull request and kill two birds with one stone. But if you can't for whatever reason, a bug report is great too.
It's here.
Sublime Text is extremely extensible and you may be using a dozen plugins that don't necessarily play well with each other.
While Vintageous tries its best to be non-intrusive, by nature uses nearly all of the keys in your keyboard, so it's pretty intrusive to begin with.
Also, check the debugging topic.
It's best to repeat ad lib until some certainty starts to form around the root of the issue.
Also, check the debugging topic.
As simple as that. And that statement is reversible too.
Cursor keys won't work after update (OS X) is better than Update breaks Vintageous for OS X. Different people use Vintageous in different ways, so don't assume the way you use Vintageous is the only one. Pack as much information in the summary line as possible. Be precise.
Standard pieces of information you can give:
- OS version
- Sublime Text 3 version
- Vintageous version
- Installed via Package Control or manually
- Logs
Explain step by step what you are doing (every step), then explain what happens and what you'd expected instead. Don't simply say that you can't move a line down. Say that pressing the j key won't move a line down in visual mode, if that's the case.
Also, there's nothing wrong with laconic bug reports if they manage to convey all necessary information.
Lastly — and above all — thank you for helping make Vintageous better!
By the way, did I already ask you to check the debugging topic?