Skip to content

Commit 6e5eaa8

Browse files
committed
generated
Signed-off-by: Psionik K <73710933+psionic-k@users.noreply.github.com>
1 parent 9c0fed6 commit 6e5eaa8

File tree

3 files changed

+55
-55
lines changed

3 files changed

+55
-55
lines changed

CONTRIBUTING.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -5,36 +5,36 @@ Development process & infrastructure guide.
55

66
# Table of Contents
77

8-
- [Submitting Pull Requests](#orgb429362)
9-
- [Development](#org65192b8)
10-
- [Running tests](#org8a3ddf5)
11-
- [Lint and byte-compile code](#org599b569)
12-
- [Loading and re-loading your package](#org9cf8d98)
13-
- [Re-generating Documentation](#org791ecf1)
14-
- [License](#org4e7d017)
15-
- [Developer Certificate of Origin (DCO)](#orgf6a4cbd)
16-
- [Sign-off](#orgf2ce616)
17-
- [GPG signature](#org6ba1a3a)
18-
- [User setup for submitting changes](#org10cbd6d)
19-
- [Maintaining versions](#org56b075d)
20-
21-
22-
<a id="orgb429362"></a>
8+
- [Submitting Pull Requests](#org1b17b33)
9+
- [Development](#org950790d)
10+
- [Running tests](#org90a3509)
11+
- [Lint and byte-compile code](#orgeee441d)
12+
- [Loading and re-loading your package](#org4a1551a)
13+
- [Re-generating Documentation](#orgcbcbabd)
14+
- [License](#orgb40cc5f)
15+
- [Developer Certificate of Origin (DCO)](#orge0e33df)
16+
- [Sign-off](#org4bc3a74)
17+
- [GPG signature](#orged4d5f8)
18+
- [User setup for submitting changes](#org3d30ff1)
19+
- [Maintaining versions](#org14701d6)
20+
21+
22+
<a id="org1b17b33"></a>
2323

2424
# Submitting Pull Requests
2525

2626
Be sure to abide by instructions in [the pull request template](../.github/pull_request_template.md).
2727

2828

29-
<a id="org65192b8"></a>
29+
<a id="org950790d"></a>
3030

3131
# Development
3232

3333
This repository was created with [elisp-repo-kit](https://github.com/positron-solutions/elisp-repo-kit/). You can use it to streamline
3434
development workflows.
3535

3636

37-
<a id="org8a3ddf5"></a>
37+
<a id="org90a3509"></a>
3838

3939
## Running tests
4040

@@ -62,7 +62,7 @@ have. **You do not need Nix to run tests pretty close to what CI does.** CI
6262
will use Nix to obtain Emacs & dependencies.
6363

6464

65-
<a id="org599b569"></a>
65+
<a id="orgeee441d"></a>
6666

6767
## Lint and byte-compile code
6868

@@ -86,7 +86,7 @@ You can run the lints manually almost the same as running tests.
8686
emacs --script .github/run-shim.el -- lint-tests
8787

8888

89-
<a id="org9cf8d98"></a>
89+
<a id="org4a1551a"></a>
9090

9191
## Loading and re-loading your package
9292

@@ -109,7 +109,7 @@ directly, call `emacs-lisp-byte-compile-and-load` or
109109
`emacs-lisp-native-compile-and-load`.
110110

111111

112-
<a id="org791ecf1"></a>
112+
<a id="orgcbcbabd"></a>
113113

114114
## Re-generating Documentation
115115

@@ -131,15 +131,15 @@ manually type the path to the `manual.info`. Honestly, just use
131131
because they use `#+include:` directives.
132132

133133

134-
<a id="org4e7d017"></a>
134+
<a id="orgb40cc5f"></a>
135135

136136
# License
137137

138138
This package is distributed under the terms of the [included license](./COPYING). The CI
139139
configuration, documentation, and scripts are MIT licensed.
140140

141141

142-
<a id="orgf6a4cbd"></a>
142+
<a id="orge0e33df"></a>
143143

144144
# Developer Certificate of Origin (DCO)
145145

@@ -152,7 +152,7 @@ A [copy of the DCO](./DCO) is distributed with this project. Read its text to
152152
understand the significance of configuring for sign-off.
153153

154154

155-
<a id="orgf2ce616"></a>
155+
<a id="org4bc3a74"></a>
156156

157157
## Sign-off
158158

@@ -163,7 +163,7 @@ following:
163163
Signed-off-by: Random J Developer <random@developer.example.org>
164164

165165

166-
<a id="org6ba1a3a"></a>
166+
<a id="orged4d5f8"></a>
167167

168168
## GPG signature
169169

@@ -174,7 +174,7 @@ participating in. Corroborating user's signature accross a history of works
174174
strengthens that user's attestation provided by DCO sign-off.
175175

176176

177-
<a id="org10cbd6d"></a>
177+
<a id="org3d30ff1"></a>
178178

179179
## User setup for submitting changes
180180

@@ -249,7 +249,7 @@ equivalent:
249249
git rebase -i
250250

251251

252-
<a id="org56b075d"></a>
252+
<a id="org14701d6"></a>
253253

254254
## Maintaining versions
255255

README.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -63,27 +63,27 @@ your secrets for Cachix. Read the CI customization section.
6363

6464
# Table of Contents
6565

66-
- [Creating Packages](#orgea06217)
67-
- [Using ERK for development](#orgda302a2)
68-
- [Find Files](#org9122b13)
69-
- [File contents and structure](#org18ffd0b)
70-
- [Finish setting up your new GitHub repo](#org988dca6)
71-
- [Optional Steps](#orgc464d5d)
72-
- [Customizing CI](#org33dd9da)
73-
- [Licensing, Developer Certificate of Origin](#orgcf113c3)
74-
- [Publishing to MELPA](#org9c83480)
75-
- [Creating the recipe](#org019b7ce)
76-
- [Testing package build](#org06993c8)
77-
- [Testing stable package build](#orgef9b1ab)
78-
- [MELPA Lints](#org250bb5a)
79-
- [Maintaining versions](#org375ed39)
80-
- [Package scope and relation to other work](#org3eb6510)
81-
- [Dependency Management](#orgdc0473a)
82-
- [Discovering and Running Tests & Lints](#org6ea37ef)
83-
- [Comparisons](#org44a2f6b)
84-
- [Contributing](#orgb0d9068)
85-
- [Footnote on FSF and Emacs Core Licensing](#org03e68cf)
86-
- [Shout-outs](#org63f3161)
66+
- [Creating Packages](#org7c6d0bd)
67+
- [Using ERK for development](#org5cb047b)
68+
- [Find Files](#org2ae729c)
69+
- [File contents and structure](#org5a796a2)
70+
- [Finish setting up your new GitHub repo](#orgdb7210d)
71+
- [Optional Steps](#orgdc9917c)
72+
- [Customizing CI](#org9460d21)
73+
- [Licensing, Developer Certificate of Origin](#org6d19600)
74+
- [Publishing to MELPA](#orgc3beb87)
75+
- [Creating the recipe](#org8ade52c)
76+
- [Testing package build](#orgfed70c7)
77+
- [Testing stable package build](#orgc9b6993)
78+
- [MELPA Lints](#org81e18de)
79+
- [Maintaining versions](#orgc670351)
80+
- [Package scope and relation to other work](#org47d3e93)
81+
- [Dependency Management](#orgc8ad0dd)
82+
- [Discovering and Running Tests & Lints](#orgccb17c7)
83+
- [Comparisons](#org41cb3df)
84+
- [Contributing](#orgc1b3d95)
85+
- [Footnote on FSF and Emacs Core Licensing](#org45c3bc0)
86+
- [Shout-outs](#orgf24edcf)
8787

8888

8989
# Creating Packages
@@ -102,7 +102,7 @@ ask you for:
102102

103103
`erk-new` also calls `erk-rename-relicense` to rename all of the files, string
104104
replace names, and re-license to GPL3. It also changes the author and resets
105-
the git history. Now just follow the steps in [finish setting up](#org988dca6) Have fun!
105+
the git history. Now just follow the steps in [finish setting up](#orgdb7210d) Have fun!
106106

107107

108108
# Using ERK for development
@@ -187,8 +187,8 @@ these choices, there is a corresponding command:
187187
├── doc
188188
│ ├── README.org # generates README.md
189189
│ ├── CONTRIBUTING.org # generates CONTRIBUTING.md
190-
│ ├── manual.org # actual manual
191-
│ └── manual.texi # generated manual for distribution
190+
│ ├── manual.org # actual manual source
191+
│ └── erk.texi # generated manual for distribution
192192
193193
├── lisp
194194
│ └── erk.el # the package
@@ -205,10 +205,10 @@ directories.
205205

206206
You can copy this checklist to your org agenda files:
207207

208-
- [X] Create a repository (from [install](#orgff995d3) instructions)
208+
- [X] Create a repository (from [install](#org78940f4) instructions)
209209
- [ ] Create an empty GitHub repository configure it as your git remote
210210
- [ ] Set up your git commit signing (and verification so that it's obvious)
211-
**and** [sign-off](#orgcf113c3) so that it will be hypothetically [straightforward](README.md) for for FSF
211+
**and** [sign-off](#org6d19600) so that it will be hypothetically [straightforward](README.md) for for FSF
212212
to pull in your changes if they later change to DCO instead of copyright
213213
assignment.
214214
- [ ] 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:
234234
**Note**, Python is used to run a DCO check script, nothing more.
235235

236236
- [ ] Get your package working, pushed, actions run, and CI badges all green
237-
- [ ] [Publish](#org9c83480) to MELPA
237+
- [ ] [Publish](#orgc3beb87) to MELPA
238238
- [ ] Make a post on [reddit](https://reddit.com/r/emacs/) and [mastodon](https://emacs.ch/) about your new package
239239

240240

doc/erk.texi

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -228,8 +228,8 @@ Elisp packages).
228228
├── doc
229229
│ ├── README.org # generates README.md
230230
│ ├── CONTRIBUTING.org # generates CONTRIBUTING.md
231-
│ ├── manual.org # actual manual
232-
│ └── manual.texi # generated manual for distribution
231+
│ ├── manual.org # actual manual source
232+
│ └── erk.texi # generated manual for distribution
233233
234234
├── lisp
235235
│ └── erk.el # the package

0 commit comments

Comments
 (0)