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.

Sign up for GitHub

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

Jump to bottom

nonspec: add instructions for checking markdown formatting #1096

Merged
merged 2 commits into from
Jul 15, 2024
Merged

nonspec: add instructions for checking markdown formatting #1096

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aa3df53
nonspec: add instructions for checking markdown formatting
TomHennen Jul 12, 2024
93462da
use the same tools as the workflow
TomHennen Jul 12, 2024
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
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,27 @@ style, as encoded in our [markdownlint configuration](.markdownlint.yaml). In
addition we prefer to keep our Markdown documents wrapped at 80 columns (though
this is not currently enforced).

To check (and fix) style problems before sending a PR you can run linting
locally with `npm run lint && ./lint.sh` or `npm run format && ./lint.sh`.

```shell
$ npm run lint && ./lint.sh

> lint
> markdownlint .

CONTRIBUTING.md:77 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Above] [Context: "### Pull request conventions"]
$ npm run format && ./lint.sh

> format
> markdownlint . --fix

$
```

If you haven't already you'll need to install npm (e.g. `sudo apt install npm`)
and package dependencies (`npm install`).

### Pull request conventions

[pull request conventions]: #pull-request-conventions
Expand Down