generated

Signed-off-by: Psionik K <[email protected]>

CONTRIBUTING.md

@@ -5,36 +5,36 @@ Development process & infrastructure guide.
 
 # Table of Contents
 
--   [Submitting Pull Requests](#org606a9eb)
--   [Development](#orgcb8ea7d)
-    -   [Running tests](#org2c0c140)
-    -   [Lint and byte-compile code](#org4934777)
-    -   [Loading and re-loading your package](#orgea5ce35)
-    -   [Re-generating Documentation](#org3edbedc)
--   [License](#org82dcc82)
--   [Developer Certificate of Origin (DCO)](#orge4b9e7a)
-    -   [Sign-off](#org06a4c0a)
-    -   [GPG signature](#orgd1a4d6c)
-    -   [User setup for submitting changes](#orgd2c4615)
-    -   [Maintaining versions](#org51f9f2c)
-
-
-<a id="org606a9eb"></a>
+-   [Submitting Pull Requests](#org1326ae4)
+-   [Development](#org31f34c1)
+    -   [Running tests](#org2bb1086)
+    -   [Lint and byte-compile code](#org5cf3e41)
+    -   [Loading and re-loading your package](#orgbaa225f)
+    -   [Re-generating Documentation](#org5c6b679)
+-   [License](#org24380ea)
+-   [Developer Certificate of Origin (DCO)](#org8ba3458)
+    -   [Sign-off](#org850864d)
+    -   [GPG signature](#org84b1181)
+    -   [User setup for submitting changes](#orgd2f3992)
+    -   [Maintaining versions](#orga8a041a)
+
+
+<a id="org1326ae4"></a>
 
 # Submitting Pull Requests
 
 Be sure to abide by instructions in [the pull request template](../.github/pull_request_template.md).
 
 
-<a id="orgcb8ea7d"></a>
+<a id="org31f34c1"></a>
 
 # Development
 
 This repository was created with [elisp-repo-kit](https://github.com/positron-solutions/elisp-repo-kit/).  You can use it to streamline
 development workflows.
 
 
-<a id="org2c0c140"></a>
+<a id="org2bb1086"></a>
 
 ## Running tests
 
@@ -62,7 +62,7 @@ have.  **You do not need Nix to run tests pretty close to what CI does.** CI
 will use Nix to obtain Emacs & dependencies.
 
 
-<a id="org4934777"></a>
+<a id="org5cf3e41"></a>
 
 ## Lint and byte-compile code
 
@@ -86,7 +86,7 @@ You can run the lints manually almost the same as running tests.
     emacs --script .github/run-shim.el -- lint-tests
 
 
-<a id="orgea5ce35"></a>
+<a id="orgbaa225f"></a>
 
 ## Loading and re-loading your package
 
@@ -109,7 +109,7 @@ directly, call `emacs-lisp-byte-compile-and-load` or
 `emacs-lisp-native-compile-and-load`.
 
 
-<a id="org3edbedc"></a>
+<a id="org5c6b679"></a>
 
 ## Re-generating Documentation
 
@@ -131,15 +131,15 @@ manually type the path to the `manual.info`.  Honestly, just use
  because they use `#+include:` directives.
 
 
-<a id="org82dcc82"></a>
+<a id="org24380ea"></a>
 
 # License
 
 This package is distributed under the terms of the [included license](./COPYING).  The CI
 configuration, documentation, and scripts are MIT licensed.
 
 
-<a id="orge4b9e7a"></a>
+<a id="org8ba3458"></a>
 
 # Developer Certificate of Origin (DCO)
 
@@ -152,7 +152,7 @@ A [copy of the DCO](./DCO) is distributed with this project.  Read its text to
 understand the significance of configuring for sign-off.
 
 
-<a id="org06a4c0a"></a>
+<a id="org850864d"></a>
 
 ## Sign-off
 
@@ -163,7 +163,7 @@ following:
     Signed-off-by: Random J Developer <[email protected]>
 
 
-<a id="orgd1a4d6c"></a>
+<a id="org84b1181"></a>
 
 ## GPG signature
 
@@ -174,7 +174,7 @@ participating in.  Corroborating user's signature accross a history of works
 strengthens that user's attestation provided by DCO sign-off.
 
 
-<a id="orgd2c4615"></a>
+<a id="orgd2f3992"></a>
 
 ## User setup for submitting changes
 
@@ -249,7 +249,7 @@ equivalent:
     git rebase -i
 
 
-<a id="org51f9f2c"></a>
+<a id="orga8a041a"></a>
 
 ## Maintaining versions
 

README.md

@@ -27,7 +27,7 @@ answer all the questions.
 # Install ERK
 
 
-    (use-package erk) ; vanilla
+    (use-package erk) ; vanilla, assuming you have MELPA configured
 
     ;; using elpaca's with explicit recipe
     (use-package erk
@@ -37,7 +37,7 @@ answer all the questions.
     (use-package erk
       :straight (erk :type git :host github :repo "positron-solutions/elisp-repo-kit"))
 
-    ;; or use melpa, manual load-path & require, you brave yak shaver
+    ;; or use manual load-path & require, you brave yak shaver
 
 
 ## Manual cloning
@@ -63,27 +63,27 @@ your secrets for Cachix. Read the CI customization section.
 
 # Table of Contents
 
--   [Creating Packages](#org48b1592)
--   [Using ERK for development](#orgac0ff0a)
-    -   [Find Files](#org5874675)
--   [File contents and structure](#org0c0d60c)
--   [Finish setting up your new GitHub repo](#orge318b14)
-    -   [Optional Steps](#org47a615b):item:
--   [Customizing CI](#orgec503c8)
--   [Licensing, Developer Certificate of Origin](#orga3c035b)
--   [Publishing to MELPA](#org233e8d2)
-    -   [Creating the recipe](#org5094545)
-    -   [Testing package build](#org2988a8d)
-    -   [Testing stable package build](#orgdea3e92)
-    -   [MELPA Lints](#orga70f644)
--   [Maintaining versions](#org31ebd2c)
--   [Package scope and relation to other work](#org7967777)
-    -   [Dependency Management](#org9325996)
-    -   [Discovering and Running Tests & Lints](#org4a9d138)
-    -   [Comparisons](#org96cc0c2)
--   [Contributing](#org59d67fb)
--   [Footnote on FSF and Emacs Core Licensing](#org01e3d0e)
--   [Shout-outs](#orgead8c3f)
+-   [Creating Packages](#org76092dc)
+-   [Using ERK for development](#orgeab3f87)
+    -   [Find Files](#org113c37b)
+-   [File contents and structure](#org52cb5b5)
+-   [Finish setting up your new GitHub repo](#org0841de1)
+    -   [Optional Steps](#org5c2c4a5)
+-   [Customizing CI](#orge90e6b2)
+-   [Licensing, Developer Certificate of Origin](#orga4735a0)
+-   [Publishing to MELPA](#org777effa)
+    -   [Creating the recipe](#orgfa257da)
+    -   [Testing package build](#org1562acd)
+    -   [Testing stable package build](#org83741c7)
+    -   [MELPA Lints](#orgd95580d)
+-   [Maintaining versions](#org7185a2e)
+-   [Package scope and relation to other work](#org296cf92)
+    -   [Dependency Management](#orga889c00)
+    -   [Discovering and Running Tests & Lints](#org2b447a7)
+    -   [Comparisons](#org8ffac82)
+-   [Contributing](#orgd2bd13c)
+-   [Footnote on FSF and Emacs Core Licensing](#org2574276)
+-   [Shout-outs](#orgc3c8572)
 
 
 # Creating Packages
@@ -100,7 +100,7 @@ ask you for:
 
 `erk-new` also calls `erk-rename-relicense` to rename all of the files, string
 replace names, and re-license to GPL3.  It also changes the author and resets
-the git history.  Now just follow the steps in [finish setting up](#orge318b14) Have fun!
+the git history.  Now just follow the steps in [finish setting up](#org0841de1) Have fun!
 
 
 # Using ERK for development
@@ -203,10 +203,10 @@ directories.
 
 You can copy this checklist to your org agenda files:
 
--   [X] Create a repository (from [install](#org10fb556) instructions)
--   [ ] Create an empty GitHub repository and check the git remote configuration
+-   [X] Create a repository (from [install](#org5847734) instructions)
+-   [ ] Create an empty GitHub repository configure it as your git remote
 -   [ ] Set up your git commit signing (and verification so that it's obvious)
-    **and** [sign-off](#orga3c035b) so that it will be hypothetically [straightforward](README.md) for for FSF
+    **and** [sign-off](#orga4735a0) so that it will be hypothetically [straightforward](README.md) for for FSF
     to pull in your changes if they later change to DCO instead of copyright
     assignment.
 -   [ ] Sign up for [cachix](https://app.cachix.org/) and, create a binary cache with API tokens and public
@@ -219,7 +219,7 @@ You can copy this checklist to your org agenda files:
     `CACHIX_AUTH_TOKEN` and `CACHIX_CACHE_NAME` (settings -> secrets -> new
     repository secret)
 
-\#+cindex github enabling actions
+\#+cindex github allowed actions
 
 -   [ ] Enable actions and add the following actions to your allowed actions list:
 
@@ -232,19 +232,20 @@ You can copy this checklist to your org agenda files:
     **Note**, Python is used to run a DCO check script, nothing more.
 
 -   [ ] Get your package working, pushed, actions run, and CI badges all green
--   [ ] [Publish](#org233e8d2) to MELPA
+-   [ ] [Publish](#org777effa) to MELPA
 -   [ ] Make a post on [reddit](https://reddit.com/r/emacs/) and [mastodon](https://emacs.ch/) about your new package
 
 
-## Optional Steps     :item:
+## Optional Steps
 
 -   [ ] Branch protect and enable check requirements for your default branch
     (usually master).  Merge commits, verified only, and no force push are
     recommended settings.
 -   [ ] Enable requiring contributors to sign-off on web-based commits
--   [ ] For **security** of your Cachix secrets and any other secrets you may someday
-    add, require Actions approval for all outside contributors and leave
-    repository permissions at read-only
+
+-   [ ] For **security** of your Cachix secrets (and any others), require
+    Actions approval for all outside contributors.  Disabling write and
+    disabling creation & approval of PR's is least privilege.
 
 Cachix is somewhat optional.  It's free for open-source projects.  It's
 about as easy to sign up and generate the token as to remove the step from
@@ -264,6 +265,7 @@ command arguments, so you can parameterize the invocations that way.
 
 -   If you need extra elisp dependencies during CI, add them to the `epkgs` list
     in the flake.nix.
+
 -   If you need extra 3rd party dependencies, add them to `packages` in the call
     to `mkShell`.
 -   To invoke different elisp operations, add / modify the commands in