Skip to content

DOC: Update contributing.rst #38938

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

Closed
BobinMathew opened this issue Jan 4, 2021 · 2 comments · Fixed by #38998
Closed

DOC: Update contributing.rst #38938

BobinMathew opened this issue Jan 4, 2021 · 2 comments · Fixed by #38998

Comments

@BobinMathew
Copy link
Contributor

Location of the documentation

doc/source/development/contributing.rst

Documentation problem

Need additional information about the command that verifies the linting of code files.

Suggested fix for documentation

pre-commit run --from-ref=upstream/master --to-ref=HEAD --all-files

The command verifies the linting of code files, it looks for common mistake patterns
NOTE: An additional paragraph is preferred for this

@BobinMathew BobinMathew added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Jan 4, 2021
@MarcoGorelli MarcoGorelli added good first issue and removed Needs Triage Issue that has not been reviewed by a pandas team member labels Jan 5, 2021
@MarcoGorelli
Copy link
Member

MarcoGorelli commented Jan 5, 2021

Thanks @BobinMathew

Yes, it would be good to mention the command

pre-commit run --from-ref=upstream/master --to-ref=HEAD --all-files

somewhere there, doesn't need to be a large addition

@vangorade
Copy link
Contributor

hi, can i work on this issue please?

@jreback jreback added this to the 1.3 milestone Jan 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants