[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] master e2b876b 154/177: Tweak README.mdown to simplify bug report
From: |
João Távora |
Subject: |
[elpa] master e2b876b 154/177: Tweak README.mdown to simplify bug reporting paragraph |
Date: |
Sat, 28 Mar 2015 15:41:36 +0000 |
branch: master
commit e2b876baef8e2e6b64df8d192a6ed2e1454b3474
Author: João Távora <address@hidden>
Commit: João Távora <address@hidden>
Tweak README.mdown to simplify bug reporting paragraph
---
README.mdown | 70 ++++++++++++++++++++++++++++++++++++---------------------
1 files changed, 44 insertions(+), 26 deletions(-)
diff --git a/README.mdown b/README.mdown
index 4a8d597..14e193f 100644
--- a/README.mdown
+++ b/README.mdown
@@ -109,44 +109,62 @@ should be added like this to `yas-snippet-dirs`:
(yas-global-mode 1) ;; or M-x yas-reload-all if you've started YASnippet
already.
-# Documentation, issues, etc
+# Manual, issues etc
-Please refer to the comprehensive (albeit slightly outdated)
-[documentation][docs] for full customization
-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])
+Please refer to the comprehensive [documentation][docs] for full
+customization and support. If you find a bug in the code or in the
+documentation, please report it on [the GitHub issue tracker][issues].
## Important note regarding bug reporting
-If you think have found a bug, please report it clearly. Yasnippet
-does have (lots of) bugs and your reports are very valuable. Here's
-a [great example](https://github.com/capitaomorte/yasnippet/issues/318)
-of a bug report. It has everything needed for a sucessfull analysis and
-speedy resolution:
-
-*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. Paste that file in your bug report. Paste any sequence
-of relevant shell commands before you launch Emacs.
-
-*Then*, describe steps taken to reproduce from an
-end-user perspective. Try to be as unambiguous as possible.
+
+Your bug reports are very valuable.
+
+The most important thing when reporting bugs is making sure that the
+developer has a way to reproduce the problem exactly like it happened
+to you.
+
+To do this, he needs to rule out interference from external factors
+like other Emacs extensions or other Lisp-side code.
+
+Here's an example that "sandboxes" an emacs just for reproducing the
+bug.
+
+```
+$ emacs --version
+Emacs 24.3
+$ cd /tmp/
+$ git clone https://github.com/capitaomorte/yasnippet.git yasnippet-bug
+$ cd yasnippet-bug
+$ git log -1 --oneline
+6053db0 Closes #527: Unbreak case where yas-fallback-behaviour is a list
+$ HOME=$PWD emacs -L # This "sandboxes" your emacs, melpa configuration, etc
+
+(require 'yasnippet)
+(yas-global-mode 1)
+
+When I open a foo-mode file I can't expand foo-mode snippets!
+OR
+I can't get yasnippet to load because frankinbogen!
+```
+
+Here's a
+[another example](https://github.com/capitaomorte/yasnippet/issues/318)
+of a bug report. It has everything needed for a sucessfull analysis
+and speedy resolution.
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.
+message string you got, unless we ask for it.
+
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).
+can't guarantee a timely response, so maybe it's better to create a
+github issue clearly marking your intent (user support/bug/feature
+request).
Finally, thank you very much for using YASnippet!
- [elpa] master 783cc33 148/177: Use cl-incf instead of cl, (continued)
- [elpa] master 783cc33 148/177: Use cl-incf instead of cl, João Távora, 2015/03/28
- [elpa] master 08b044e 149/177: Merge pull request #519 from syohex/use-cl-macro, João Távora, 2015/03/28
- [elpa] master e731451 150/177: Signal an error on recursive yas--fallback calls, João Távora, 2015/03/28
- [elpa] master 6877bc6 151/177: Merge pull request #524 from npostavs/fallback-loop, João Távora, 2015/03/28
- [elpa] master 37df653 142/177: yasnippet-debug.el: quiet byte-compiler, João Távora, 2015/03/28
- [elpa] master 70151f4 152/177: Closes #525, closes #526: Prevent some keybinding fallback loops, João Távora, 2015/03/28
- [elpa] master 6053db0 153/177: Closes #527: Unbreak case where yas-fallback-behaviour is a list, João Távora, 2015/03/28
- [elpa] master b22961a 155/177: Update README.mdown, João Távora, 2015/03/28
- [elpa] master 596e6b2 158/177: Closes #537: Be lenient to extensions operating on snippet fields, João Távora, 2015/03/28
- [elpa] master 1c97671 157/177: Closes #536: Fix navigation to zero-length fields at snippet end, João Távora, 2015/03/28
- [elpa] master e2b876b 154/177: Tweak README.mdown to simplify bug reporting paragraph,
João Távora <=
- [elpa] master 51d4ed1 156/177: Update snippets submodule, João Távora, 2015/03/28
- [elpa] master 175e0a3 159/177: Clean up previous change, João Távora, 2015/03/28
- [elpa] master 50ca8d3 160/177: Update README.mdown, João Távora, 2015/03/28
- [elpa] master bb6bbad 161/177: Add file doc/.nosearch, João Távora, 2015/03/28
- [elpa] master 9709dbd 164/177: Add autoload cookies, João Távora, 2015/03/28
- [elpa] master b62bdf3 163/177: Closes #546: backport `yas-initialize' and provide `yas/initialize', João Távora, 2015/03/28
- [elpa] master e161fc0 162/177: Merge pull request #542 from tarsius/nosearch, João Távora, 2015/03/28
- [elpa] master 07734a1 165/177: Clarify what happens with yas-new-snippet., João Távora, 2015/03/28
- [elpa] master 3c13348 167/177: yas-expand-snippet: Clarify EXPAND-ENV, João Távora, 2015/03/28
- [elpa] master 21ffe4b 168/177: Merge pull request #559 from mineo/patch-1, João Távora, 2015/03/28