[elpa] externals/eglot 1460324706 03/33: Update bug_report.md

[Stefan Kangas]

branch: externals/eglot
commit 1460324706d03291883cfcd13e59c4f5f55f3dc0
Author: João Távora <joaotavora@gmail.com>
Commit: GitHub <noreply@github.com>

    Update bug_report.md
---
 .github/ISSUE_TEMPLATE/bug_report.md | 64 ++++++++++++++++++++++--------------
 1 file changed, 40 insertions(+), 24 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md 
b/.github/ISSUE_TEMPLATE/bug_report.md
index 9df438b61e..edda64d99f 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -6,19 +6,23 @@ labels: ''
 assignees: ''
 ---
 <!-- Hello there, prospective issue reporter! Your bug reports are
-     very valuable 💛.  They really are, and Eglot couldn't be made
-     without them.  But there are lots of bugs and so little time.  So
+     very valuable 💛 💛 💛.  They really are, and Eglot couldn't be 
+     made without them.  But there are lots of bugs and so little 
+     time.  So:
 
         PLEASE - DO NOT - REMOVE OR SKIP PARTS OF THIS TEMPLATE.
   
-     👉🏽 Need help configuring or understanding Emacs, Eglot, or LSP?
-     Have an idea for a feature?  Please DON'T OPEN A NEW ISSUE!
+     👉 Need help configuring or understanding Emacs, Eglot, or LSP?
+       Have an idea for a feature?  Please DON'T OPEN A NEW ISSUE!
   
-     * Head to https://github.com/joaotavora/eglot/discussions to
+       Head to https://github.com/joaotavora/eglot/discussions to
        discuss.  Start a new discussion, there are no templates there,
-       you can say whatever you want.
+       you can just speak your mind.
+
+     👉 Maybe your issue is already solved or worked around.  Have glance at
+       
https://github.com/joaotavora/eglot/issues?q=is%3Aissue+label%3Aworkaround
   
-     * You can also make an Emacs bug report, which can also be used
+     👉 You can also make an Emacs bug report, which can also be used
        for general discussion.  You'll potentially reach more people
        this way.  You can do it via `M-x report-emacs-bug` or just
        send email to `bug-gnu-emacs@gnu.org`.  Be sure to `CC:` (or
@@ -28,9 +32,13 @@ assignees: ''
      To make an issue, you need to provide some elements, which aren't
      hard to find.  Can't find all the elements for this template?
      No problem, just make a discussion 👆.
+
+     Here's an example of a 👌 fine issue report following this template:
+     https://github.com/joaotavora/eglot/issues/696
      
      If you don't provide the needed elements, WE MAY CLOSE THE ISSUE
-     JUST LIKE THAT 😐 . -->
+     JUST LIKE THAT 😐. 
+-->
      
 * Server used:               <!-- (clangd, gopls, etc..) -->
 * Emacs version:             <!-- Type M-x emacs-version -->
@@ -40,7 +48,8 @@ assignees: ''
 * Using Doom:                <!-- Yes/No -->
 
 #### LSP transcript - M-x eglot-events-buffer (mandatory unless Emacs 
inoperable)
-<!-- DO NOT SKIP OR REMOVE: Include the invaluable LSP transcript .
+<!-- DO NOT SKIP: Include the invaluable LSP transcript.
+
      Inside Emacs, you can display that buffer with the M-x
      eglot-events-buffer command. It contains the JSONRPC messages
      exchanged between client and server, as well as the messages the
@@ -55,11 +64,13 @@ assignees: ''
 ```
     
 #### Backtrace (mandatory, unless no error message seen or heard):
-<!-- DO NOT SKIP OR REMOVE: If Emacs errored (you saw -- and possibly
-     heard -- an error message), make sure you repeat the process
-     after enabling backtraces with `M-x toggle-debug-on-error`.  The
-     backtrace buffer contains text that you should also include here,
-     again as a formatted code block. -->
+<!-- DO NOT SKIP: 
+
+     If Emacs errored (you saw -- and possibly heard -- an error message), 
+     make sure you repeat the process after enabling backtraces with 
+     `M-x toggle-debug-on-error`.  The backtrace buffer contains text that 
+     you should include here, again as a formatted code block. 
+-->
      
 ```lisp
 ... Paste the backtrace here ...
@@ -74,30 +85,35 @@ Debugger entered--Lisp error: (error "oh no")
 ```
    
 #### Minimal configuration (mandatory)
-<!-- DO NOT SKIP OR REMOVE: Are you using Doom Emacs or Spacemacs
-     Emacs or some very special pimped-out Emacs?  That's fine, but
-     for this report we need to be able to replicate the problem JUST
-     AS IT HAPPENED TO YOU.  We can't replicate your complex
-     configuration and environment, so you need to provide a MINIMAL,
-     REPRODUCIBLE and COMPLETE recipe.
+<!-- DO NOT SKIP: 
+
+     Are you using Doom Emacs or Spacemacs Emacs or some very special 
+     pimped-out Emacs?  That's fine, but for this report we need to be 
+     able to replicate the problem JUST AS IT HAPPENED TO YOU.  
+
+     We can't and don't have time to replicate your complex configuration 
+     and environment, so you need to provide a MINIMAL, REPRODUCIBLE and 
+     COMPLETE recipe.
      
-     How to do this? Here's the easiest way provided you can use the
-     shell in your system:-->
+     How to do this?  The easiest recipes just start Emacs from the shell:
+-->
      
  ```sh
  # Type this in a shell to start an Emacs with Eglot configured
  $ /path/to/a/certain/version/of/emacs -Q -f package-initialize -L 
/path/to/git-cloned/eglot -l eglot.el 
  ```
  
+ <!-- Then you add a bit of Elisp code that can be typed into *scratch* -->
+ 
  ```lisp
- ;; Example of a minimal init.el configuration
+ ;; Example of a minimal configuration
  ;;
  (add-to-list 'eglot-server-programs '(foo-mode "foo-server"))
  (setq eglot-special-option-2000 '(foo bar with the airplane)) 
  (some-clearly-identified-third-party-package)
   ```
  
- <!-- WHEW!!
+ <!-- WHEW!! THANK YOU!
  
       For some bugs, all this may seem like overkill but believe us,
       very often what seems like a "clear issue" is actually specific