Skip to content

Commit 37bd670

Browse files
committed
Request that docs use semantic linefeeds
We use this style to make it easier to edit rendered documentation.
1 parent dc44a46 commit 37bd670

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,9 @@ a GitHub Action runs [Mike],
106106
which commits a new version of the docs to the `gh-pages` branch
107107
so that it is deployed to [GitHub Pages].
108108

109+
When editing our documentation, please use [semantic linefeeds][].
110+
(For a formal definition which we only loosely adhere to, see [sembr.org][sembr].)
111+
109112
To build the docs locally, you will need the "docs" dependency-group installed
110113
(if you have already installed the "dev" group, you can skip this):
111114

@@ -126,4 +129,6 @@ mkdocs serve
126129
[Mike]: https://github.com/jimporter/mike
127130
[MkDocs]: https://www.mkdocs.org/
128131
[keepachangelog]: https://keepachangelog.com/
132+
[semantic linefeeds]: https://rhodesmill.org/brandon/2012/one-sentence-per-line/
133+
[sembr]: https://sembr.org/
129134
[semver]: https://semver.org/

0 commit comments

Comments
 (0)