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

Update CONTRIBUTING.md Setup Instructions #3046

Merged
merged 1 commit into from
Aug 26, 2024

Conversation

siddk
Copy link
Contributor

@siddk siddk commented Aug 26, 2024

What does this PR do?

CONTRIBUTING.md has developers only install quality dependencies (black, hf-doc-builder, ruff) rather than full set of testing dependencies. Since the documentation requires folks run tests anyway, update instructions to install dev dependencies.

Not sure if this is overkill (and we just want pytest / parameterized as specified with the test_prod target).

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).

Who can review?

@muellerzr

@siddk siddk changed the title [Documentation] CONTRIBUTING.md Setup Instructions should Install Dev/Test Dependencies Update CONTRIBUTING.md Setup Instructions Aug 26, 2024
@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

Copy link
Collaborator

@muellerzr muellerzr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for going through and refreshing our directions 🤗

@muellerzr muellerzr merged commit 8c3aded into huggingface:main Aug 26, 2024
2 checks passed
@siddk siddk deleted the update-contributing-setup branch August 26, 2024 14:45
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 this pull request may close these issues.

3 participants