I noticed while reviewing #130 that there were some markdown formatting issues. I ran prettier locally and addressed issues raised by my editor (which appears to use markdownlint under the hood).
To make this a little easier to keep on top of this PR adds pre-commit checks that run prettier and markdownlint. I've also added a CI step cribbed from dask/dask to check this automatically.
This PR contains a lot of changes, similar to project wide Black PRs. A summary of changes include:
I noticed while reviewing #130 that there were some markdown formatting issues. I ran
prettier
locally and addressed issues raised by my editor (which appears to usemarkdownlint
under the hood).To make this a little easier to keep on top of this PR adds
pre-commit
checks that run prettier and markdownlint. I've also added a CI step cribbed fromdask/dask
to check this automatically.This PR contains a lot of changes, similar to project wide Black PRs. A summary of changes include:
pre-commit
config file.prettierrc
and.prettierignore
config files.markdownlint.json
config fileprettier
andmarkdownlint
on all files.