aboutsummaryrefslogtreecommitdiff
path: root/NEWS
diff options
context:
space:
mode:
authorCraig Jennings <c@cjennings.net>2026-05-05 10:48:02 -0500
committerCraig Jennings <c@cjennings.net>2026-05-05 10:48:02 -0500
commit54c7f01dc752ca4bbcc46762cc2ba617cff7411c (patch)
tree2fd3472a084812fb28b0bfd4822d6280f690b334 /NEWS
parentc099037dd2dfde8cfa2e4c286c8be1fada4277cf (diff)
downloadorg-drill-54c7f01dc752ca4bbcc46762cc2ba617cff7411c.tar.gz
org-drill-54c7f01dc752ca4bbcc46762cc2ba617cff7411c.zip
docs: add LICENSE, CONTRIBUTING, CHANGELOG, and NEWS files
Four new top-level docs to round out the project's public-facing materials: - LICENSE: full GPL-3 text, mirroring the header notice in org-drill.el (copied from emacs-wttrin's bundled license). - CONTRIBUTING.md: bug-reporting guide, patch flow (fork → branch → tests → PR), development setup instructions wrapping the existing make targets, and testing/style notes pointing at the TDD discipline expected. - CHANGELOG.md: keepachangelog format with an Unreleased section documenting every change since the fork — bug fixes by issue number, new infrastructure (CI, coverage, lint), structural refactors, and removals. - NEWS: shorter user-facing summary highlighting the bugs most likely to have bitten existing users. Closes the [#A] TODO 'Add CONTRIBUTING, CHANGELOG, NEWS, and a standalone LICENSE file'.
Diffstat (limited to 'NEWS')
-rw-r--r--NEWS66
1 files changed, 66 insertions, 0 deletions
diff --git a/NEWS b/NEWS
new file mode 100644
index 0000000..bda8bc5
--- /dev/null
+++ b/NEWS
@@ -0,0 +1,66 @@
+org-drill NEWS — user-facing highlights since the fork
+=======================================================
+
+For the full chronological log, see CHANGELOG.md. This file
+collects the changes a user is most likely to feel.
+
+Since the fork (no tagged release yet)
+--------------------------------------
+
+* Several long-standing bugs that users reported upstream are
+ fixed. If you've ever seen any of these, this fork should help:
+
+ - "[Y-08-27 Wed 16:%]"-shaped timestamps in DRILL_LAST_REVIEWED
+ (issue #59).
+ - Your default-input-method getting silently set to nil after a
+ drill session (issues #52, #58 — particularly noticeable for
+ users with non-Latin input methods).
+ - Drill entries whose answer lived inside a child sub-heading
+ being silently skipped (issue #13).
+ - The cloze face leaking onto unrelated org headings (issue #38).
+ - "Window system frame should be used" error when running
+ org-drill in a TTY emacsclient (issue #44 — affects tmux
+ setups in particular).
+ - org-drill-final-report not firing after an edit-and-resume
+ cycle (issue #33).
+ - "Wrong type argument: hash-table-p, nil" stopping a session
+ after the first new (no-ID) entry, forcing one-at-a-time
+ invocations (issue #53).
+ - Crash on package load when the persist file got corrupted
+ (issue #45).
+ - Stray "[debug] org-drill: at marker position N" message logged
+ on every drilled card.
+ - Cards with DRILL_CARD_TYPE: translate_number hitting a
+ void-function error.
+
+* Org 9.6 is now the minimum supported version. org-drill calls
+ org-fold-show-entry / org-fold-show-subtree (introduced in 9.6)
+ in seven places without guards — the dependency now matches
+ what the runtime needs, so a too-old Org will fail at install
+ time with a clear message rather than a cryptic void-function
+ error during a session.
+
+* org-drill-resume and org-drill-again now produce a clear
+ user-error when there's no previous session to resume, instead
+ of a cryptic eieio type error.
+
+* New M-x targets exposed via the existing keymap haven't been
+ added; everything is still launched via M-x org-drill,
+ M-x org-drill-cram, M-x org-drill-resume, etc.
+
+For developers
+--------------
+
+* Test coverage went from ~12% to ~78% on org-drill.el. The
+ tests/ directory now holds ~370 ERT tests across 27 files.
+
+* GitHub Actions CI runs the test matrix (Emacs 28.2 / 29.4 /
+ snapshot), lint, and coverage on every push to main.
+
+* The Makefile gained `make coverage`, `make compile`,
+ `make lint`, and `make validate-parens` targets. See the
+ CONTRIBUTING.md file for the full developer setup.
+
+* `make install` was renamed to `make setup` (it installs Cask
+ dependencies into a project-local .cask/ directory, not the
+ package onto the user's system).