Skip to content

Describe running lint and spellcheck locally in README/Contributing guide #2338

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

Merged
AA-Turner merged 7 commits into from
Feb 22, 2022
Merged

Describe running lint and spellcheck locally in README/Contributing guide #2338

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
6dfa2b3
Add and consolidate codeowners for linting infrastructure
CAM-Gerlach Feb 17, 2022
945b213
Update Makefile to use alias for lint and spellcheck jobs
CAM-Gerlach Feb 17, 2022
efb7b46
Update the README to provide more detail on checking PEP rendering
CAM-Gerlach Feb 17, 2022
250f98e
Add explaination for how to use pre-commit in Contributing Guide
CAM-Gerlach Feb 17, 2022
b88d052
Add section to Contributing Guide on how to check PEP spelling
CAM-Gerlach Feb 18, 2022
9ddc9a8
Improve readme and contributing guide sections further with reviewer …
CAM-Gerlach Feb 18, 2022
6ec177e
Format check, lint & spelling commands in Readme/Contribguide as blocks
CAM-Gerlach Feb 18, 2022
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
Prev Previous commit
Next Next commit
Update Makefile to use alias for lint and spellcheck jobs
  • Loading branch information
@CAM-Gerlach
CAM-Gerlach committed Feb 17, 2022
commit 945b213d149baf85de6668b8724b7a8cd3e53353
4 changes: 2 additions & 2 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,11 @@ package: all rss
tar -C build -czf build/peps.tar.gz peps

lint:
pre-commit --version > /dev/null || python3 -m pip install pre-commit
pre-commit --version > /dev/null || $(PYTHON) -m pip install pre-commit
pre-commit run --all-files

spellcheck:
pre-commit --version > /dev/null || python3 -m pip install pre-commit
pre-commit --version > /dev/null || $(PYTHON) -m pip install pre-commit
pre-commit run --all-files --hook-stage manual codespell

# New Sphinx targets:
Expand Down