From 6e5eaa8b6317d596d0721a3d7656bfb89ff2f847 Mon Sep 17 00:00:00 2001 From: Psionik K <73710933+psionic-k@users.noreply.github.com> Date: Mon, 23 Oct 2023 23:41:39 -0500 Subject: [PATCH] generated Signed-off-by: Psionik K <73710933+psionic-k@users.noreply.github.com> --- CONTRIBUTING.md | 52 +++++++++++++++++++++++------------------------ README.md | 54 ++++++++++++++++++++++++------------------------- doc/erk.texi | 4 ++-- 3 files changed, 55 insertions(+), 55 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6e32ab8..b82212d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,28 +5,28 @@ Development process & infrastructure guide. # Table of Contents -- [Submitting Pull Requests](#orgb429362) -- [Development](#org65192b8) - - [Running tests](#org8a3ddf5) - - [Lint and byte-compile code](#org599b569) - - [Loading and re-loading your package](#org9cf8d98) - - [Re-generating Documentation](#org791ecf1) -- [License](#org4e7d017) -- [Developer Certificate of Origin (DCO)](#orgf6a4cbd) - - [Sign-off](#orgf2ce616) - - [GPG signature](#org6ba1a3a) - - [User setup for submitting changes](#org10cbd6d) - - [Maintaining versions](#org56b075d) - - - +- [Submitting Pull Requests](#org1b17b33) +- [Development](#org950790d) + - [Running tests](#org90a3509) + - [Lint and byte-compile code](#orgeee441d) + - [Loading and re-loading your package](#org4a1551a) + - [Re-generating Documentation](#orgcbcbabd) +- [License](#orgb40cc5f) +- [Developer Certificate of Origin (DCO)](#orge0e33df) + - [Sign-off](#org4bc3a74) + - [GPG signature](#orged4d5f8) + - [User setup for submitting changes](#org3d30ff1) + - [Maintaining versions](#org14701d6) + + + # Submitting Pull Requests Be sure to abide by instructions in [the pull request template](../.github/pull_request_template.md). - + # Development @@ -34,7 +34,7 @@ This repository was created with [elisp-repo-kit](https://github.com/positron-so development workflows. - + ## 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. - + ## 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 - + ## 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`. - + ## Re-generating Documentation @@ -131,7 +131,7 @@ manually type the path to the `manual.info`. Honestly, just use because they use `#+include:` directives. - + # License @@ -139,7 +139,7 @@ This package is distributed under the terms of the [included license](./COPYING) configuration, documentation, and scripts are MIT licensed. - + # 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. - + ## Sign-off @@ -163,7 +163,7 @@ following: Signed-off-by: Random J Developer - + ## 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. - + ## User setup for submitting changes @@ -249,7 +249,7 @@ equivalent: git rebase -i - + ## Maintaining versions diff --git a/README.md b/README.md index d13e582..a88f338 100644 --- a/README.md +++ b/README.md @@ -63,27 +63,27 @@ your secrets for Cachix. Read the CI customization section. # Table of Contents -- [Creating Packages](#orgea06217) -- [Using ERK for development](#orgda302a2) - - [Find Files](#org9122b13) -- [File contents and structure](#org18ffd0b) -- [Finish setting up your new GitHub repo](#org988dca6) - - [Optional Steps](#orgc464d5d) -- [Customizing CI](#org33dd9da) -- [Licensing, Developer Certificate of Origin](#orgcf113c3) -- [Publishing to MELPA](#org9c83480) - - [Creating the recipe](#org019b7ce) - - [Testing package build](#org06993c8) - - [Testing stable package build](#orgef9b1ab) - - [MELPA Lints](#org250bb5a) -- [Maintaining versions](#org375ed39) -- [Package scope and relation to other work](#org3eb6510) - - [Dependency Management](#orgdc0473a) - - [Discovering and Running Tests & Lints](#org6ea37ef) - - [Comparisons](#org44a2f6b) -- [Contributing](#orgb0d9068) -- [Footnote on FSF and Emacs Core Licensing](#org03e68cf) -- [Shout-outs](#org63f3161) +- [Creating Packages](#org7c6d0bd) +- [Using ERK for development](#org5cb047b) + - [Find Files](#org2ae729c) +- [File contents and structure](#org5a796a2) +- [Finish setting up your new GitHub repo](#orgdb7210d) + - [Optional Steps](#orgdc9917c) +- [Customizing CI](#org9460d21) +- [Licensing, Developer Certificate of Origin](#org6d19600) +- [Publishing to MELPA](#orgc3beb87) + - [Creating the recipe](#org8ade52c) + - [Testing package build](#orgfed70c7) + - [Testing stable package build](#orgc9b6993) + - [MELPA Lints](#org81e18de) +- [Maintaining versions](#orgc670351) +- [Package scope and relation to other work](#org47d3e93) + - [Dependency Management](#orgc8ad0dd) + - [Discovering and Running Tests & Lints](#orgccb17c7) + - [Comparisons](#org41cb3df) +- [Contributing](#orgc1b3d95) +- [Footnote on FSF and Emacs Core Licensing](#org45c3bc0) +- [Shout-outs](#orgf24edcf) # Creating Packages @@ -102,7 +102,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](#org988dca6) Have fun! +the git history. Now just follow the steps in [finish setting up](#orgdb7210d) Have fun! # Using ERK for development @@ -187,8 +187,8 @@ these choices, there is a corresponding command: ├── doc │ ├── README.org # generates README.md │ ├── CONTRIBUTING.org # generates CONTRIBUTING.md - │ ├── manual.org # actual manual - │ └── manual.texi # generated manual for distribution + │ ├── manual.org # actual manual source + │ └── erk.texi # generated manual for distribution │ ├── lisp │ └── erk.el # the package @@ -205,10 +205,10 @@ directories. You can copy this checklist to your org agenda files: -- [X] Create a repository (from [install](#orgff995d3) instructions) +- [X] Create a repository (from [install](#org78940f4) 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](#orgcf113c3) so that it will be hypothetically [straightforward](README.md) for for FSF + **and** [sign-off](#org6d19600) 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 @@ -234,7 +234,7 @@ 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](#org9c83480) to MELPA +- [ ] [Publish](#orgc3beb87) to MELPA - [ ] Make a post on [reddit](https://reddit.com/r/emacs/) and [mastodon](https://emacs.ch/) about your new package diff --git a/doc/erk.texi b/doc/erk.texi index d68c5a4..ea791e7 100644 --- a/doc/erk.texi +++ b/doc/erk.texi @@ -228,8 +228,8 @@ Elisp packages). ├── doc │ ├── README.org # generates README.md │ ├── CONTRIBUTING.org # generates CONTRIBUTING.md -│ ├── manual.org # actual manual -│ └── manual.texi # generated manual for distribution +│ ├── manual.org # actual manual source +│ └── erk.texi # generated manual for distribution │ ├── lisp │ └── erk.el # the package