diff --git a/README.mdown b/README.mdown index dc10bfb..075951e 100644 --- a/README.mdown +++ b/README.mdown @@ -131,8 +131,37 @@ and support. If you find a bug, please report it on [the GitHub issue tracker][issues]. (please **do not** submit new issues to the old [googlecode tracker][googlecode tracker]) -If you run into problems using YASnippet, or have snippets to contribute, post -to the [YASnippet google group][forum]. Thank you very much for using YASnippet! +## Important note regarding bug reporting +If you think have found a bug, please report it clearly. Yasnippet +does have (lots of) bugs and your reporting is very valuable. But I +have little time to analyse bugs and the following helps a lot. + +So, *before* reporting try to reproduce the bug **without** your usual +`.emacs` (or whatever startup file you use). Do so either by starting +emacs from the command line with the `-Q` switch, or by temporarily +moving away your `.emacs` and creating a new smaller one just for +reproducing the bug. + +Then paste that file, and describe steps taken to reproduce, from an +end-user perspective. Try to be as unambiguous as possible. Also, +don't forget to state the Emacs version (use `M-x emacs-version`) and +the yasnippet version you are using (if using the latest from github, +do `git log -1` in the dir). + +Any more info is welcome, but don't just paste a backtrace or an error +message string you got. I'm not saying your analysis might not be +useful but following the instructions above immediately gives me a +clear picture of what is happening. + +There's an example of a great bug report from +[issue #189](https://github.com/capitaomorte/yasnippet/issues/189) + +There is also a [YASnippet google group][forum]. I will keep the group +open for reference and for discussion among users, unfortunately I +can't guarantee a timely response, so maybe creating a github issue +clearly marking your intent (user support/bug/feature request). + +Finally, thank you very much for using YASnippet! [docs]: http://capitaomorte.github.com/yasnippet/ [issues]: https://github.com/capitaomorte/yasnippet/issues