Reporting Bugs

While it isn’t necessary, it is useful, in creating an issue describing your bug, if you could include reproduction steps that use a minimal Emacs configuration and a minimal example demonstrating the bug. Here’s how you can do that:

1. Create a file called example-init.el.

   It should contain just the bare minimum needed to load Symex and any other packages essential to your bug scenario. For example:

   ;; -*- lexical-binding: t; -*-
   
   (defvar bootstrap-version)
   (let ((bootstrap-file
          (expand-file-name
           "straight/repos/straight.el/bootstrap.el"
           (or (bound-and-true-p straight-base-dir)
               user-emacs-directory)))
         (bootstrap-version 7))
     (unless (file-exists-p bootstrap-file)
       (with-current-buffer
           (url-retrieve-synchronously
            "https://raw.githubusercontent.com/radian-software/straight.el/develop/install.el"
            'silent 'inhibit-cookies)
         (goto-char (point-max))
         (eval-print-last-sexp)))
     (load bootstrap-file nil 'nomessage))
   
   (use-package symex-core
     :straight
     (symex-core
      :host github
      :repo "drym-org/symex.el"
      :files ("symex-core/symex*.el")))
   
   (use-package symex
     :after (symex-core)
     :straight
     (symex
      :host github
      :repo "drym-org/symex.el"
      :files ("symex/symex*.el" "symex/doc/*.texi" "symex/doc/figures"))
     :config
     (symex-mode 1)
     (global-set-key (kbd "s-;") #'symex-mode-interface))

2. At the command line, run emacs -Q --load example-init.el.

3. Create a test file using this minimal Emacs that demonstrates your bug.

4. Include both the config and the test file in your bug report.