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

Lint/format docs #467

Closed
oliverjam opened this issue Jun 7, 2021 · 0 comments · Fixed by #875
Closed

Lint/format docs #467

oliverjam opened this issue Jun 7, 2021 · 0 comments · Fixed by #875
Assignees
Labels
enhancement New feature or request next-circle

Comments

@oliverjam
Copy link
Contributor

oliverjam commented Jun 7, 2021

There's currently a git pre-commit hook that auto-formats all files with Prettier. However this relies on contributors running npm install at least once, which isn't necessarily going to happen.

We should have a GitHub Action to automatically run this against any PR. It should also use remark-lint to check the Markdown files for common mistakes, inclusive language, plus any other stylistic choices we want to enforce.

https://katydecorah.com/code/lint-markdown/
https://katydecorah.com/code/copyeditor/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request next-circle
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants