Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make all heading levels consistent #1080

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .copy-edit-stylesheet-checklist.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
# Basic checklist/stylesheet used for copy editing BOLTs

Contributions should comply with this checklist/stylesheet to maintain correct, clear, consistent, and concise BOLTS.
Items marked as 'lint' can be automatically checked by running `tools/lint.sh`.

- headings
- first line is top-level heading (lint)
- there is only one top-level heading in the document (lint)
- spelling
- run `tools/spellcheck.sh --check [0-9][0-9]-*.md`
- update `.aspell.en.pws` with any missing words
Expand Down
12 changes: 12 additions & 0 deletions .github/workflows/checks.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
on: [push, pull_request]

jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: DavidAnson/markdownlint-cli2-action@v15
with:
globs: |
??-*.md
proposals/*.md
9 changes: 9 additions & 0 deletions .markdownlint.jsonc
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"default": false,

// There should be only one top-level heading.
"MD025": true,

// The first line should be top-level heading.
"MD041": true
}
Loading