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

Add contributor documentation for how to run header/reST checks, codespell and other linting locally #2265

Closed
CAM-Gerlach opened this issue Jan 25, 2022 · 0 comments · Fixed by #2338
Assignees

Comments

@CAM-Gerlach
Copy link
Member

Right now, we run some basic pre-commit checks of the headers and reST on the CIs, as added in #1802 and extended in #1886 (based off #1803 ), which were also intended to allow PEP authors/editors to check their PEPs locally. However, the readme, contributing guide, nor /docs explain how to do this, or even explicitly mention it. Therefore, I'll add a step by step explanation to the contributing guide, along with some form of the admonition mentioned in #2151 .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant