aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWilliam Rankin <william@bydasein.com>2020-09-26 02:46:37 +1000
committerWilliam Rankin <william@bydasein.com>2020-09-27 16:28:14 +1000
commit8e67ca845524037290fe9573aee8b32f60360fe2 (patch)
treebab567081760e828f0fa43d84e2927100f9435bc
parent19185486ce53eb45d20126c6da8e50dc627359b4 (diff)
downloadbinder-8e67ca845524037290fe9573aee8b32f60360fe2.zip
Update issue template
-rw-r--r--.github/ISSUE_TEMPLATE/bug-report.md29
-rw-r--r--.github/ISSUE_TEMPLATE/support.md2
-rw-r--r--.github/issue_template.md14
-rw-r--r--README.md50
-rw-r--r--binder.el50
5 files changed, 80 insertions, 65 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md
new file mode 100644
index 0000000..77ef6e3
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug-report.md
@@ -0,0 +1,29 @@
+---
+name: Bug Report
+about: For problems with Binder
+---
+
+## Description
+
+
+
+## Steps to Reproduce
+
+<!-- You MUST begin your bug report with the following: -->
+
+1. `$ emacs -Q -l binder.el`
+2.
+
+## Configuration
+
+- `M-: emacs-version`
+- `M-: (lm-version "binder.el")`
+
+<!--
+ You may need to call `M-: (require 'lisp-mnt)` for the above to work.
+ Please don't link to your configuration files or paste configuration code.
+-->
+
+## I acknowledge I have...
+
+- [ ] reproduced this bug when launching with `emacs -Q -l binder.el`
diff --git a/.github/ISSUE_TEMPLATE/support.md b/.github/ISSUE_TEMPLATE/support.md
index a5c2b3d..01a6b47 100644
--- a/.github/ISSUE_TEMPLATE/support.md
+++ b/.github/ISSUE_TEMPLATE/support.md
@@ -9,6 +9,6 @@ about: Additional help with Binder
## I acknowledge I have...
-- [ ] read the README file
+- [ ] read the README or code Commentary
- [ ] read the help provided by `C-h m`
- [ ] completed the tutorial with `M-x binder-tutorial`
diff --git a/.github/issue_template.md b/.github/issue_template.md
deleted file mode 100644
index d76919f..0000000
--- a/.github/issue_template.md
+++ /dev/null
@@ -1,14 +0,0 @@
----
-name: Bug report
-about: For problems with Binder
----
-
-(For feature requests, feel free to delete and disregard this.)
-
-1. `$ emacs -Q`
-2. `M-x load-file RET binder.el`
-3. ... etc.
-
-
-- `M-: emacs-version`:
-- `M-: (lm-version "binder.el")`:
diff --git a/README.md b/README.md
index d962af7..2e2a284 100644
--- a/README.md
+++ b/README.md
@@ -37,31 +37,31 @@ can be repeated without prefix key/s.
You'll mostly interact with the project structure via the sidebar.
-- `binder-toggle-sidebar (C-c ')` toggles the visibility of the binder
- sidebar.
-- `binder-reveal-in-sidebar (C-c ;)` finds the current file in the
- sidebar.
-
-Each project item is a file, referenced relative to the project
-directory. Project items are displayed in a linear ordered list. Calling
-`binder-sidebar-find-file (RET)` or `binder-sidebar-find-file-other-window (o)`
-will visit the corresponding file.
-
-Each item in the sidebar displays the following information:
-
-1. `binder-sidebar-include-char` (default x) denotes that this item is
- included when the "joining" the project (see **Concatentate** below).
-2. `binder-sidebar-notes-char` (default *) denotes that this item has some
- notes, which can be edited in `binder-notes-mode` (see below), or...
-3. `binder-sidebar-missing-char` (default ?) denote that the item's
- corresponding file cannot be found, but can be relocated by calling
- `binder-sidebar-relocate (R)`. The item will also highlight red.
-4. The item name, which is either the file relative to the project
- directory or an arbitrary display name, which can be set by calling
- `binder-sidebar-rename (r)`.
-5. The item tags, each prefixed with `binder-sidebar-status-char`
- (default #). The tags column can be set with the
- `binder-sidebar-tags-column` option.
+- `binder-toggle-sidebar (C-c ')` toggles the visibility of the binder
+ sidebar
+- `binder-reveal-in-sidebar (C-c ;)` finds the current file in the
+ sidebar
+
+Each project items is a file reference relative to the project
+directory. Items are displayed as:
+
+ x * name #tag1 #tag2
+
+These things mean:
+
+|------|-------------------------------------------------|
+| x | item is included when concatenating the project |
+| * | item has notes |
+| ? | the item's corresponding file cannot be found |
+| name | the file name (or custom display name) |
+| #tag | arbitrary item tags |
+|------|-------------------------------------------------|
+
+An item's display name can be changed with `binder-sidebar-rename (r)`.
+If a file cannot be found, relocate with `binder-sidebar-relocate (R)`.
+
+Calling `binder-sidebar-find-file (RET)` will visit the corresponding
+file.
To add an existing file, call `binder-sidebar-add-file (a)` or add all
files in directory with `binder-sidebar-add-all-files (A)`.
diff --git a/binder.el b/binder.el
index 7c9e5e7..400b48a 100644
--- a/binder.el
+++ b/binder.el
@@ -59,31 +59,31 @@
;; You'll mostly interact with the project structure via the sidebar.
-;; - binder-toggle-sidebar (C-c ') toggles the visibility of the binder
-;; sidebar.
-;; - binder-reveal-in-sidebar (C-c ;) finds the current file in the
-;; sidebar.
-
-;; Each project item is a file, referenced relative to the project
-;; directory. Project items are displayed in a linear ordered list. Calling
-;; binder-sidebar-find-file (RET) or binder-sidebar-find-file-other-window (o)
-;; will visit the corresponding file.
-
-;; Each item in the sidebar displays the following information:
-
-;; 1. binder-sidebar-include-char (default x) denotes that this item is
-;; included when the "joining" the project (see **Concatentate** below).
-;; 2. binder-sidebar-notes-char (default *) denotes that this item has some
-;; notes, which can be edited in binder-notes-mode (see below), or...
-;; 3. binder-sidebar-missing-char (default ?) denote that the item's
-;; corresponding file cannot be found, but can be relocated by calling
-;; binder-sidebar-relocate (R). The item will also highlight red.
-;; 4. The item name, which is either the file relative to the project
-;; directory or an arbitrary display name, which can be set by calling
-;; binder-sidebar-rename (r).
-;; 5. The item tags, each prefixed with binder-sidebar-status-char
-;; (default #). The tags column can be set with the
-;; binder-sidebar-tags-column option.
+;; - binder-toggle-sidebar (C-c ') toggles the visibility of the binder
+;; sidebar
+;; - binder-reveal-in-sidebar (C-c ;) finds the current file in the
+;; sidebar
+
+;; Each project items is a file reference relative to the project
+;; directory. Items are displayed as:
+
+;; x * name #tag1 #tag2
+
+;; These things mean:
+
+;; |------|-------------------------------------------------|
+;; | x | item is included when concatenating the project |
+;; | * | item has notes |
+;; | ? | the item's corresponding file cannot be found |
+;; | name | the file name (or custom display name) |
+;; | #tag | arbitrary item tags |
+;; |------|-------------------------------------------------|
+
+;; An item's display name can be changed with binder-sidebar-rename (r).
+;; If a file cannot be found, relocate with binder-sidebar-relocate (R).
+
+;; Calling binder-sidebar-find-file (RET) will visit the corresponding
+;; file.
;; To add an existing file, call binder-sidebar-add-file (a) or add all
;; files in directory with binder-sidebar-add-all-files (A).